From 3b2d87fd083e796d8d057ecac958e9dd7b50f503 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Thu, 9 Nov 2023 15:14:59 +0530 Subject: [PATCH] initial commit for risc0 hash benchmark --- hash/risc0/bench/.gitignore | 4 + hash/risc0/bench/.vscode/settings.json | 5 + hash/risc0/bench/Cargo.toml | 17 ++ hash/risc0/bench/LICENSE | 201 ++++++++++++++++++ hash/risc0/bench/README.md | 101 +++++++++ hash/risc0/bench/host/Cargo.toml | 21 ++ .../bench/host/benches/sha256_benchmarks.rs | 46 ++++ hash/risc0/bench/host/src/lib.rs | 71 +++++++ hash/risc0/bench/methods/Cargo.toml | 10 + hash/risc0/bench/methods/build.rs | 3 + hash/risc0/bench/methods/guest/Cargo.toml | 10 + hash/risc0/bench/methods/guest/src/main.rs | 24 +++ hash/risc0/bench/methods/src/lib.rs | 1 + hash/risc0/bench/rust-toolchain.toml | 4 + 14 files changed, 518 insertions(+) create mode 100644 hash/risc0/bench/.gitignore create mode 100644 hash/risc0/bench/.vscode/settings.json create mode 100644 hash/risc0/bench/Cargo.toml create mode 100644 hash/risc0/bench/LICENSE create mode 100644 hash/risc0/bench/README.md create mode 100644 hash/risc0/bench/host/Cargo.toml create mode 100644 hash/risc0/bench/host/benches/sha256_benchmarks.rs create mode 100644 hash/risc0/bench/host/src/lib.rs create mode 100644 hash/risc0/bench/methods/Cargo.toml create mode 100644 hash/risc0/bench/methods/build.rs create mode 100644 hash/risc0/bench/methods/guest/Cargo.toml create mode 100644 hash/risc0/bench/methods/guest/src/main.rs create mode 100644 hash/risc0/bench/methods/src/lib.rs create mode 100644 hash/risc0/bench/rust-toolchain.toml diff --git a/hash/risc0/bench/.gitignore b/hash/risc0/bench/.gitignore new file mode 100644 index 0000000..f4247e1 --- /dev/null +++ b/hash/risc0/bench/.gitignore @@ -0,0 +1,4 @@ +.DS_Store +Cargo.lock +methods/guest/Cargo.lock +target/ diff --git a/hash/risc0/bench/.vscode/settings.json b/hash/risc0/bench/.vscode/settings.json new file mode 100644 index 0000000..4545fa6 --- /dev/null +++ b/hash/risc0/bench/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "rust-analyzer.linkedProjects": [ + "./methods/guest/Cargo.toml" + ] +} \ No newline at end of file diff --git a/hash/risc0/bench/Cargo.toml b/hash/risc0/bench/Cargo.toml new file mode 100644 index 0000000..5363877 --- /dev/null +++ b/hash/risc0/bench/Cargo.toml @@ -0,0 +1,17 @@ +[workspace] +resolver = "2" +members = ["host", "methods"] + +# Always optimize; building and running the guest takes much longer without optimization. +[profile.dev] +opt-level = 3 + +[profile.dev.build-override] +opt-level = 3 + +[profile.release] +debug = 1 +lto = true + +[profile.release.build-override] +opt-level = 3 diff --git a/hash/risc0/bench/LICENSE b/hash/risc0/bench/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/hash/risc0/bench/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/hash/risc0/bench/README.md b/hash/risc0/bench/README.md new file mode 100644 index 0000000..f1d1022 --- /dev/null +++ b/hash/risc0/bench/README.md @@ -0,0 +1,101 @@ +# RISC Zero Rust Starter Template + +Welcome to the RISC Zero Rust Starter Template! This template is intended to +give you a starting point for building a project using the RISC Zero zkVM. +Throughout the template (including in this README), you'll find comments +labelled `TODO` in places where you'll need to make changes. To better +understand the concepts behind this template, check out the [zkVM +Overview][zkvm-overview]. + +## Quick Start + +First, make sure [rustup] is installed. The +[`rust-toolchain.toml`][rust-toolchain] file will be used by `cargo` to +automatically install the correct version. + +To build all methods and execute the method within the zkVM, run the following +command: + +```bash +cargo run +``` + +This is an empty template, and so there is no expected output (until you modify +the code). + +### Running proofs remotely on Bonsai + +_Note: The Bonsai proving service is still in early Alpha; an API key is +required for access. [Click here to request access][bonsai access]._ + +If you have access to the URL and API key to Bonsai you can run your proofs +remotely. To prove in Bonsai mode, invoke `cargo run` with two additional +environment variables: + +```bash +BONSAI_API_KEY="YOUR_API_KEY" BONSAI_API_URL="BONSAI_URL" cargo run +``` + +## How to create a project based on this template + +Search this template for the string `TODO`, and make the necessary changes to +implement the required feature described by the `TODO` comment. Some of these +changes will be complex, and so we have a number of instructional resources to +assist you in learning how to write your own code for the RISC Zero zkVM: + +- The [RISC Zero Developer Docs][dev-docs] is a great place to get started. +- Example projects are available in the [examples folder][examples] of + [`risc0`][risc0-repo] repository. +- Reference documentation is available at [https://docs.rs][docs.rs], including + [`risc0-zkvm`][risc0-zkvm], [`cargo-risczero`][cargo-risczero], + [`risc0-build`][risc0-build], and [others][crates]. + +## Directory Structure + +It is possible to organize the files for these components in various ways. +However, in this starter template we use a standard directory structure for zkVM +applications, which we think is a good starting point for your applications. + +```text +project_name +├── Cargo.toml +├── host +│ ├── Cargo.toml +│ └── src +│ └── main.rs <-- [Host code goes here] +└── methods + ├── Cargo.toml + ├── build.rs + ├── guest + │ ├── Cargo.toml + │ └── src + │ └── bin + │ └── method_name.rs <-- [Guest code goes here] + └── src + └── lib.rs +``` + +## Video Tutorial + +For a walk-through of how to build with this template, check out this [excerpt +from our workshop at ZK HACK III][zkhack-iii]. + +## Questions, Feedback, and Collaborations + +We'd love to hear from you on [Discord][discord] or [Twitter][twitter]. + +[bonsai access]: https://bonsai.xyz/apply +[cargo-risczero]: https://docs.rs/cargo-risczero +[crates]: https://github.com/risc0/risc0/blob/main/README.md#rust-binaries +[dev-docs]: https://dev.risczero.com +[discord]: https://discord.gg/risczero +[docs.rs]: https://docs.rs/releases/search?query=risc0 +[examples]: https://github.com/risc0/risc0/tree/main/examples +[risc0-build]: https://docs.rs/risc0-build +[risc0-repo]: https://www.github.com/risc0/risc0 +[risc0-zkvm]: https://docs.rs/risc0-zkvm +[rustup]: https://rustup.rs +[rust-toolchain]: rust-toolchain.toml +[twitter]: https://twitter.com/risczero +[zkvm-overview]: https://dev.risczero.com/zkvm +[zkhack-iii]: https://www.youtube.com/watch?v=Yg_BGqj_6lg&list=PLcPzhUaCxlCgig7ofeARMPwQ8vbuD6hC5&index=5 diff --git a/hash/risc0/bench/host/Cargo.toml b/hash/risc0/bench/host/Cargo.toml new file mode 100644 index 0000000..c28882c --- /dev/null +++ b/hash/risc0/bench/host/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "host" +version = "0.1.0" +edition = "2021" + +[dependencies] +methods = { path = "../methods" } +risc0-zkvm = { version = "0.19.0" } +serde = "1.0" +rand = "0.8.5" + +[dev-dependencies] +criterion = "0.5.1" + +[[bench]] +name = "sha256_benchmarks" +harness = false + +[[bin]] +name = "host" +path = "src/lib.rs" \ No newline at end of file diff --git a/hash/risc0/bench/host/benches/sha256_benchmarks.rs b/hash/risc0/bench/host/benches/sha256_benchmarks.rs new file mode 100644 index 0000000..fb0d9d5 --- /dev/null +++ b/hash/risc0/bench/host/benches/sha256_benchmarks.rs @@ -0,0 +1,46 @@ + +use host::sha_bench; +use criterion::{criterion_group, criterion_main, Criterion}; +use rand::RngCore; +fn sha256_1kb(c: &mut Criterion) { + c.bench_function("sha256_bench", |b| { + //generating 1kb of random data in a vector of u8 + let mut data = [0u8; 64]; + rand::thread_rng().fill_bytes(&mut data); + let input: Vec = data.to_vec(); + + // println!("{:?}", input); + b.iter(|| { + sha_bench(input.clone()); + // hasher.update(data); + // black_box(hasher.finalize()); + }); + }); + + c.bench_function("sha256_bench", |b| { + //generating 1kb of random data in a vector of u8 + let mut data = [0u8; 64]; + rand::thread_rng().fill_bytes(&mut data); + let input: Vec = data.to_vec(); + + // println!("{:?}", input); + b.iter(|| { + sha_bench(input.clone()); + // hasher.update(data); + // black_box(hasher.finalize()); + }); + }); + +} + +criterion_group!( + name = benches; + + // Setting the sample size to 10 for quick benchmarks + // Becuase running default number of samples(100) takes a lot of time + config = Criterion::default().sample_size(10); + targets = sha256_1kb +); + +// criterion_group!(benches, sha256_bench); +criterion_main!(benches); diff --git a/hash/risc0/bench/host/src/lib.rs b/hash/risc0/bench/host/src/lib.rs new file mode 100644 index 0000000..8ff50cd --- /dev/null +++ b/hash/risc0/bench/host/src/lib.rs @@ -0,0 +1,71 @@ +// These constants represent the RISC-V ELF and the image ID generated by risc0-build. +// The ELF is used for proving and the ID is used for verification. +use methods::{ + METHOD_ELF, METHOD_ID +}; +use risc0_zkvm::{default_prover, ExecutorEnv}; +use risc0_zkvm::{ sha}; + +pub fn sha_bench(input: Vec) { + // An executor environment describes the configurations for the zkVM + // including program inputs. + // An default ExecutorEnv can be created like so: + // `let env = ExecutorEnv::builder().build().unwrap();` + // However, this `env` does not have any inputs. + // + // To add add guest input to the executor environment, use + // ExecutorEnvBuilder::write(). + // To access this method, you'll need to use ExecutorEnv::builder(), which + // creates an ExecutorEnvBuilder. When you're done adding input, call + // ExecutorEnvBuilder::build(). + + // For example: + // let input: u32 = 15*2^27 + 1; + // let input: Vec = data.to_vec(); + let env = ExecutorEnv::builder().write(&input).unwrap().build().unwrap(); + + // Obtain the default prover. + let prover = default_prover(); + + // Produce a receipt by proving the specified ELF binary. + let receipt = prover.prove_elf(env, METHOD_ELF).unwrap(); + + // TODO: Implement code for retrieving receipt journal here. + + // For example: + let _output: sha::Digest = receipt.journal.decode().unwrap(); + // println!("output: {:?}", _output); + // Optional: Verify receipt to confirm that recipients will also be able to + // verify your receipt + // receipt.verify(METHOD_ID).unwrap(); +} + +fn main() { + sha_bench(vec![97, 98, 99, 100, 101, 102, 103, 104]); +} + +// #[cfg(test)] +// mod benches { +// extern crate criterion; + +// use criterion::{black_box, criterion_group, criterion_main, Criterion}; +// use crate::main as your_function_to_benchmark; +// // Your benchmark function + +// fn my_benchmark(c: &mut Criterion) { +// c.bench_function("my_function", |b| { +// b.iter(|| { +// // Code to benchmark +// let result = your_function_to_benchmark(); +// black_box(result); +// }); +// }); +// } + +// // Define other benchmark functions here + +// criterion_group!(benches, my_benchmark); +// criterion_main!(benches); +// } + + diff --git a/hash/risc0/bench/methods/Cargo.toml b/hash/risc0/bench/methods/Cargo.toml new file mode 100644 index 0000000..30d237a --- /dev/null +++ b/hash/risc0/bench/methods/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "methods" +version = "0.1.0" +edition = "2021" + +[build-dependencies] +risc0-build = { version = "0.19.0" } + +[package.metadata.risc0] +methods = ["guest"] diff --git a/hash/risc0/bench/methods/build.rs b/hash/risc0/bench/methods/build.rs new file mode 100644 index 0000000..08a8a4e --- /dev/null +++ b/hash/risc0/bench/methods/build.rs @@ -0,0 +1,3 @@ +fn main() { + risc0_build::embed_methods(); +} diff --git a/hash/risc0/bench/methods/guest/Cargo.toml b/hash/risc0/bench/methods/guest/Cargo.toml new file mode 100644 index 0000000..550f6bf --- /dev/null +++ b/hash/risc0/bench/methods/guest/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "method" +version = "0.1.0" +edition = "2021" + +[workspace] + +[dependencies] +# If you want to try (experimental) std support, add `features = [ "std" ]` to risc0-zkvm +risc0-zkvm = { version = "0.19.0", default-features = false, features = [ "std" ] } diff --git a/hash/risc0/bench/methods/guest/src/main.rs b/hash/risc0/bench/methods/guest/src/main.rs new file mode 100644 index 0000000..ceffa06 --- /dev/null +++ b/hash/risc0/bench/methods/guest/src/main.rs @@ -0,0 +1,24 @@ +#![no_main] +// If you want to try std support, also update the guest Cargo.toml file + + +use risc0_zkvm::{guest::env, sha, sha::Sha256}; + +risc0_zkvm::guest::entry!(main); + + +pub fn main() { + // // TODO: Implement your guest code here + + // // read the input + // let input: u32 = env::read(); + + // // TODO: do something with the input + + // // write public output to the journal + // env::commit(&input); + + let data: Vec = env::read(); + let hash = sha::Impl::hash_bytes(&data); + env::commit(&hash) +} diff --git a/hash/risc0/bench/methods/src/lib.rs b/hash/risc0/bench/methods/src/lib.rs new file mode 100644 index 0000000..1bdb308 --- /dev/null +++ b/hash/risc0/bench/methods/src/lib.rs @@ -0,0 +1 @@ +include!(concat!(env!("OUT_DIR"), "/methods.rs")); diff --git a/hash/risc0/bench/rust-toolchain.toml b/hash/risc0/bench/rust-toolchain.toml new file mode 100644 index 0000000..36614c3 --- /dev/null +++ b/hash/risc0/bench/rust-toolchain.toml @@ -0,0 +1,4 @@ +[toolchain] +channel = "stable" +components = ["rustfmt", "rust-src"] +profile = "minimal"