-
Notifications
You must be signed in to change notification settings - Fork 143
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
Erc20 bench #1174
Open
tmontaigu
wants to merge
1
commit into
main
Choose a base branch
from
tm/erc20
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Erc20 bench #1174
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,301 @@ | ||
use criterion::measurement::WallTime; | ||
use criterion::{BenchmarkGroup, Criterion, Throughput}; | ||
use rand::prelude::*; | ||
use rand::thread_rng; | ||
use rayon::prelude::*; | ||
use std::ops::{Add, Mul, Sub}; | ||
use tfhe::prelude::*; | ||
use tfhe::shortint::parameters::*; | ||
use tfhe::{set_server_key, ClientKey, CompressedServerKey, ConfigBuilder, FheBool, FheUint64}; | ||
|
||
/// Transfer as written in the original FHEvm white-paper, | ||
/// it uses a comparison to check if the sender has enough, | ||
/// and cmuxes based on the comparison result | ||
fn transfer_whitepaper<FheType>( | ||
from_amount: &FheType, | ||
to_amount: &FheType, | ||
amount: &FheType, | ||
) -> (FheType, FheType) | ||
where | ||
FheType: Add<Output = FheType> + for<'a> FheOrd<&'a FheType>, | ||
FheBool: IfThenElse<FheType>, | ||
for<'a> &'a FheType: Add<Output = FheType> + Sub<Output = FheType>, | ||
{ | ||
let has_enough_funds = (from_amount).ge(amount); | ||
|
||
let mut new_to_amount = to_amount + amount; | ||
new_to_amount = has_enough_funds.if_then_else(&new_to_amount, to_amount); | ||
|
||
let mut new_from_amount = from_amount - amount; | ||
new_from_amount = has_enough_funds.if_then_else(&new_from_amount, from_amount); | ||
|
||
(new_from_amount, new_to_amount) | ||
} | ||
|
||
/// This one also uses a comparison, but it leverages the 'boolean' multiplication | ||
/// instead of cmuxes, so it is faster | ||
fn transfer_no_cmux<FheType>( | ||
from_amount: &FheType, | ||
to_amount: &FheType, | ||
amount: &FheType, | ||
) -> (FheType, FheType) | ||
where | ||
FheType: Add<Output = FheType> + CastFrom<FheBool> + for<'a> FheOrd<&'a FheType>, | ||
FheBool: IfThenElse<FheType>, | ||
for<'a> &'a FheType: | ||
Add<Output = FheType> + Sub<Output = FheType> + Mul<FheType, Output = FheType>, | ||
{ | ||
let has_enough_funds = (from_amount).ge(amount); | ||
|
||
let amount = amount * FheType::cast_from(has_enough_funds); | ||
|
||
let new_to_amount = to_amount + &amount; | ||
let new_from_amount = from_amount - &amount; | ||
|
||
(new_from_amount, new_to_amount) | ||
} | ||
|
||
/// This one uses overflowing sub to remove the need for comparison | ||
/// it also uses the 'boolean' multiplication | ||
fn transfer_overflow<FheType>( | ||
from_amount: &FheType, | ||
to_amount: &FheType, | ||
amount: &FheType, | ||
) -> (FheType, FheType) | ||
where | ||
FheType: CastFrom<FheBool> + for<'a> FheOrd<&'a FheType>, | ||
FheBool: IfThenElse<FheType>, | ||
for<'a> &'a FheType: Add<FheType, Output = FheType> | ||
+ OverflowingSub<&'a FheType, Output = FheType> | ||
+ Mul<FheType, Output = FheType>, | ||
{ | ||
let (new_from, did_not_have_enough) = (from_amount).overflowing_sub(amount); | ||
|
||
let new_from_amount = did_not_have_enough.if_then_else(from_amount, &new_from); | ||
|
||
let had_enough_funds = !did_not_have_enough; | ||
let new_to_amount = to_amount + (amount * FheType::cast_from(had_enough_funds)); | ||
|
||
(new_from_amount, new_to_amount) | ||
} | ||
|
||
/// This ones uses both overflowing_add/sub to check that both | ||
/// the sender has enough funds, and the receiver will not overflow its balance | ||
fn transfer_safe<FheType>( | ||
from_amount: &FheType, | ||
to_amount: &FheType, | ||
amount: &FheType, | ||
) -> (FheType, FheType) | ||
where | ||
for<'a> &'a FheType: OverflowingSub<&'a FheType, Output = FheType> | ||
+ OverflowingAdd<&'a FheType, Output = FheType>, | ||
FheBool: IfThenElse<FheType>, | ||
{ | ||
let (new_from, did_not_have_enough_funds) = (from_amount).overflowing_sub(amount); | ||
let (new_to, did_not_have_enough_space) = (to_amount).overflowing_add(amount); | ||
|
||
let something_not_ok = did_not_have_enough_funds | did_not_have_enough_space; | ||
|
||
let new_from_amount = something_not_ok.if_then_else(from_amount, &new_from); | ||
let new_to_amount = something_not_ok.if_then_else(to_amount, &new_to); | ||
|
||
(new_from_amount, new_to_amount) | ||
} | ||
|
||
#[cfg(feature = "pbs-stats")] | ||
fn print_transfer_pbs_counts<FheType, F>( | ||
client_key: &ClientKey, | ||
type_name: &str, | ||
fn_name: &str, | ||
transfer_func: F, | ||
) where | ||
FheType: FheEncrypt<u64, ClientKey>, | ||
F: for<'a> Fn(&'a FheType, &'a FheType, &'a FheType) -> (FheType, FheType), | ||
{ | ||
let mut rng = thread_rng(); | ||
|
||
let from_amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
let to_amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
let amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
|
||
tfhe::reset_pbs_count(); | ||
let (_, _) = transfer_func(&from_amount, &to_amount, &amount); | ||
let count = tfhe::get_pbs_count(); | ||
|
||
println!("ERC20 transfer/{fn_name}::{type_name}: {count} PBS"); | ||
} | ||
|
||
fn bench_transfer_latency<FheType, F>( | ||
c: &mut BenchmarkGroup<'_, WallTime>, | ||
client_key: &ClientKey, | ||
type_name: &str, | ||
fn_name: &str, | ||
transfer_func: F, | ||
) where | ||
FheType: FheEncrypt<u64, ClientKey>, | ||
F: for<'a> Fn(&'a FheType, &'a FheType, &'a FheType) -> (FheType, FheType), | ||
{ | ||
let id_name = format!("{fn_name}::{type_name}"); | ||
c.bench_function(&id_name, |b| { | ||
let mut rng = thread_rng(); | ||
|
||
let from_amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
let to_amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
let amount = FheType::encrypt(rng.gen::<u64>(), client_key); | ||
|
||
b.iter(|| { | ||
let (_, _) = transfer_func(&from_amount, &to_amount, &amount); | ||
}) | ||
}); | ||
} | ||
|
||
fn bench_transfer_throughput<FheType, F>( | ||
group: &mut BenchmarkGroup<'_, WallTime>, | ||
client_key: &ClientKey, | ||
type_name: &str, | ||
fn_name: &str, | ||
transfer_func: F, | ||
) where | ||
FheType: FheEncrypt<u64, ClientKey> + Send + Sync, | ||
F: for<'a> Fn(&'a FheType, &'a FheType, &'a FheType) -> (FheType, FheType) + Sync, | ||
{ | ||
let mut rng = thread_rng(); | ||
|
||
for num_elems in [10, 100, 500] { | ||
group.throughput(Throughput::Elements(num_elems)); | ||
let id_name = format!("{fn_name}::{type_name}::{num_elems}"); | ||
group.bench_with_input(id_name, &num_elems, |b, &num_elems| { | ||
let from_amounts = (0..num_elems) | ||
.map(|_| FheType::encrypt(rng.gen::<u64>(), client_key)) | ||
.collect::<Vec<_>>(); | ||
let to_amounts = (0..num_elems) | ||
.map(|_| FheType::encrypt(rng.gen::<u64>(), client_key)) | ||
.collect::<Vec<_>>(); | ||
let amounts = (0..num_elems) | ||
.map(|_| FheType::encrypt(rng.gen::<u64>(), client_key)) | ||
.collect::<Vec<_>>(); | ||
|
||
b.iter(|| { | ||
from_amounts | ||
.par_iter() | ||
.zip(to_amounts.par_iter().zip(amounts.par_iter())) | ||
.for_each(|(from_amount, (to_amount, amount))| { | ||
let (_, _) = transfer_func(from_amount, to_amount, amount); | ||
}) | ||
}) | ||
}); | ||
} | ||
} | ||
|
||
fn main() { | ||
#[cfg(not(feature = "gpu"))] | ||
let params = PARAM_MESSAGE_2_CARRY_2_KS_PBS_TUNIFORM_2M64; | ||
#[cfg(feature = "gpu")] | ||
let params = PARAM_GPU_MULTI_BIT_MESSAGE_2_CARRY_2_GROUP_3_KS_PBS; | ||
|
||
let config = ConfigBuilder::with_custom_parameters(params).build(); | ||
let cks = ClientKey::generate(config); | ||
let compressed_sks = CompressedServerKey::new(&cks); | ||
|
||
#[cfg(not(feature = "gpu"))] | ||
let sks = compressed_sks.decompress(); | ||
#[cfg(feature = "gpu")] | ||
let sks = compressed_sks.decompress_to_gpu(); | ||
|
||
rayon::broadcast(|_| set_server_key(sks.clone())); | ||
set_server_key(sks); | ||
|
||
let mut c = Criterion::default().sample_size(10).configure_from_args(); | ||
|
||
// FheUint64 PBS counts | ||
// We don't run multiple times since every input is encrypted | ||
// PBS count is always the same | ||
#[cfg(feature = "pbs-stats")] | ||
{ | ||
print_transfer_pbs_counts( | ||
&cks, | ||
"FheUint64", | ||
"whitepaper", | ||
transfer_whitepaper::<FheUint64>, | ||
); | ||
print_transfer_pbs_counts(&cks, "FheUint64", "no_cmux", transfer_no_cmux::<FheUint64>); | ||
print_transfer_pbs_counts( | ||
&cks, | ||
"FheUint64", | ||
"overflow", | ||
transfer_overflow::<FheUint64>, | ||
); | ||
print_transfer_pbs_counts(&cks, "FheUint64", "safe", transfer_safe::<FheUint64>); | ||
} | ||
|
||
// FheUint64 latency | ||
{ | ||
let mut group = c.benchmark_group("ERC20 latency"); | ||
bench_transfer_latency( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"whitepaper", | ||
transfer_whitepaper::<FheUint64>, | ||
); | ||
bench_transfer_latency( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"no_cmux", | ||
transfer_no_cmux::<FheUint64>, | ||
); | ||
bench_transfer_latency( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"overflow", | ||
transfer_overflow::<FheUint64>, | ||
); | ||
bench_transfer_latency( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"safe", | ||
transfer_safe::<FheUint64>, | ||
); | ||
|
||
group.finish(); | ||
} | ||
|
||
// FheUint64 Throughput | ||
{ | ||
let mut group = c.benchmark_group("ERC20 throughput"); | ||
bench_transfer_throughput( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"whitepaper", | ||
transfer_whitepaper::<FheUint64>, | ||
); | ||
bench_transfer_throughput( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"no_cmux", | ||
transfer_no_cmux::<FheUint64>, | ||
); | ||
bench_transfer_throughput( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"overflow", | ||
transfer_overflow::<FheUint64>, | ||
); | ||
bench_transfer_throughput( | ||
&mut group, | ||
&cks, | ||
"FheUint64", | ||
"safe", | ||
transfer_safe::<FheUint64>, | ||
); | ||
group.finish(); | ||
} | ||
|
||
c.final_summary(); | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these benchmarks never meant to be stored in database ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hum I think we want to store them in a database but they are not integer bench so we likely need a different database/schema and we would need to store both the throughput and latency (and pbs count if posssible)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok so we need to discuss how to add them.