Skip to content

feat(shortint): adds generic client key for atomic pattern support #2334

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

Merged
merged 2 commits into from
May 26, 2025
Merged

feat(shortint): adds generic client key for atomic pattern support #2334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b05166f
feat(shortint): adds generic client key for atomic pattern support
nsarlin-zama May 21, 2025
20df907
chore(shortint): modswitch noise reduction key upgrade without clone
nsarlin-zama May 23, 2025
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
6 changes: 4 additions & 2 deletions tests/backward_compatibility/shortint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,11 +138,13 @@ pub fn test_shortint_clientkey(

let key: ClientKey = load_and_unversionize(dir, test, format)?;

if test_params != key.parameters {
if test_params != key.parameters() {
Err(test.failure(
format!(
"Invalid {} parameters:\n Expected :\n{:?}\nGot:\n{:?}",
format, test_params, key.parameters
format,
test_params,
key.parameters()
),
format,
))
Expand Down
12 changes: 6 additions & 6 deletions tfhe-benchmark/benches/shortint/bench.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ fn bench_server_key_unary_function<F>(

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;

let clear_text = rng.gen::<u64>() % modulus;

Expand Down Expand Up @@ -70,7 +70,7 @@ fn bench_server_key_binary_function<F>(

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;

let clear_0 = rng.gen::<u64>() % modulus;
let clear_1 = rng.gen::<u64>() % modulus;
Expand Down Expand Up @@ -115,7 +115,7 @@ fn bench_server_key_binary_scalar_function<F>(

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;

let clear_0 = rng.gen::<u64>() % modulus;
let clear_1 = rng.gen::<u64>() % modulus;
Expand Down Expand Up @@ -159,7 +159,7 @@ fn bench_server_key_binary_scalar_division_function<F>(

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;
assert_ne!(modulus, 1);

let clear_0 = rng.gen::<u64>() % modulus;
Expand Down Expand Up @@ -200,7 +200,7 @@ fn carry_extract_bench(c: &mut Criterion) {

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;

let clear_0 = rng.gen::<u64>() % modulus;

Expand Down Expand Up @@ -236,7 +236,7 @@ fn programmable_bootstrapping_bench(c: &mut Criterion) {

let mut rng = rand::thread_rng();

let modulus = cks.parameters.message_modulus().0;
let modulus = cks.parameters().message_modulus().0;

let acc = sks.generate_lookup_table(|x| x);

Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/references/fine-grained-apis/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ fn main() {
let msg1 = 1;
let msg2 = 0;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/references/fine-grained-apis/shortint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ fn main() {
let msg1 = 1;
let msg2 = 0;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down
16 changes: 8 additions & 8 deletions tfhe/docs/references/fine-grained-apis/shortint/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ fn main() {
let msg2 = 3;
let scalar = 4;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let mut ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -91,7 +91,7 @@ fn main() {
let msg2 = 3;
let scalar = 4;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let mut ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -134,7 +134,7 @@ fn main() {
let msg2 = 3;
let scalar = 4;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let mut ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -168,7 +168,7 @@ fn main() {
let msg2 = 3;
let scalar = 4;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the client key to encrypt two messages:
let mut ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -244,7 +244,7 @@ fn main() {
let msg1 = 2;
let msg2 = 1;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the private client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -275,7 +275,7 @@ fn main() {
let msg1 = 2;
let msg2 = 1;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the private client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -306,7 +306,7 @@ fn main() {
let msg1 = 2;
let msg2 = 1;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the private client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down Expand Up @@ -365,7 +365,7 @@ fn main() {
let msg1 = 3;
let msg2 = 2;

let modulus = client_key.parameters.message_modulus().0;
let modulus = client_key.parameters().message_modulus().0;

// We use the private client key to encrypt two messages:
let ct_1 = client_key.encrypt(msg1);
Expand Down
6 changes: 3 additions & 3 deletions tfhe/src/high_level_api/keys/inner.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ impl IntegerClientKey {
);
let mut seeder = DeterministicSeeder::<DefaultRandomGenerator>::new(seed);
let cks = crate::shortint::engine::ShortintEngine::new_from_seeder(&mut seeder)
.new_client_key(config.block_parameters.into());
.new_client_key(config.block_parameters);

let key = crate::integer::ClientKey::from(cks);

Expand Down Expand Up @@ -172,15 +172,15 @@ impl IntegerClientKey {

if let Some(dedicated_compact_private_key) = dedicated_compact_private_key.as_ref() {
assert_eq!(
shortint_cks.parameters.message_modulus(),
shortint_cks.parameters().message_modulus(),
dedicated_compact_private_key
.0
.key
.parameters()
.message_modulus,
);
assert_eq!(
shortint_cks.parameters.carry_modulus(),
shortint_cks.parameters().carry_modulus(),
dedicated_compact_private_key
.0
.key
Expand Down
6 changes: 3 additions & 3 deletions tfhe/src/integer/client_key/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ impl ClientKey {
}

pub fn parameters(&self) -> crate::shortint::AtomicPatternParameters {
self.key.parameters.ap_parameters().unwrap()
self.key.parameters().ap_parameters().unwrap()
}

#[cfg(test)]
Expand Down Expand Up @@ -333,7 +333,7 @@ impl ClientKey {
return T::ZERO;
}

let bits_in_block = self.key.parameters.message_modulus().0.ilog2();
let bits_in_block = self.key.parameters().message_modulus().0.ilog2();
let decrypted_block_iter = blocks.iter().map(|block| decrypt_block(&self.key, block));
BlockRecomposer::recompose_unsigned(decrypted_block_iter, bits_in_block)
}
Expand Down Expand Up @@ -417,7 +417,7 @@ impl ClientKey {
return T::ZERO;
}

let bits_in_block = self.key.parameters.message_modulus().0.ilog2();
let bits_in_block = self.key.parameters().message_modulus().0.ilog2();
let decrypted_block_iter = ctxt
.blocks
.iter()
Expand Down
2 changes: 1 addition & 1 deletion tfhe/src/integer/encryption.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pub(crate) trait KnowsMessageModulus {

impl KnowsMessageModulus for crate::shortint::ClientKey {
fn message_modulus(&self) -> MessageModulus {
self.parameters.message_modulus()
self.parameters().message_modulus()
}
}

Expand Down
25 changes: 15 additions & 10 deletions tfhe/src/integer/gpu/client_key/radix.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use crate::integer::gpu::list_compression::server_keys::{
};
use crate::integer::gpu::server_key::CudaBootstrappingKey;
use crate::integer::RadixClientKey;
use crate::shortint::client_key::atomic_pattern::AtomicPatternClientKey;
use crate::shortint::engine::ShortintEngine;
use crate::shortint::EncryptionKeyChoice;

Expand All @@ -21,7 +22,11 @@ impl RadixClientKey {
) -> (CudaCompressionKey, CudaDecompressionKey) {
let private_compression_key = &private_compression_key.key;

let params = &private_compression_key.params;
let compression_params = &private_compression_key.params;

let AtomicPatternClientKey::Standard(std_cks) = &self.as_ref().key.atomic_pattern else {
panic!("Only the standard atomic pattern is supported on GPU")
};

assert_eq!(
self.parameters().encryption_key_choice(),
Expand All @@ -32,11 +37,11 @@ impl RadixClientKey {
// Compression key
let packing_key_switching_key = ShortintEngine::with_thread_local_mut(|engine| {
allocate_and_generate_new_lwe_packing_keyswitch_key(
&self.as_ref().key.large_lwe_secret_key(),
&std_cks.large_lwe_secret_key(),
&private_compression_key.post_packing_ks_key,
params.packing_ks_base_log,
params.packing_ks_level,
params.packing_ks_key_noise_distribution,
compression_params.packing_ks_base_log,
compression_params.packing_ks_level,
compression_params.packing_ks_key_noise_distribution,
self.parameters().ciphertext_modulus(),
&mut engine.encryption_generator,
)
Expand All @@ -45,7 +50,7 @@ impl RadixClientKey {
let glwe_compression_key = CompressionKey {
key: crate::shortint::list_compression::CompressionKey {
packing_key_switching_key,
lwe_per_glwe: params.lwe_per_glwe,
lwe_per_glwe: compression_params.lwe_per_glwe,
storage_log_modulus: private_compression_key.params.storage_log_modulus,
},
};
Expand All @@ -60,9 +65,9 @@ impl RadixClientKey {
self.parameters().polynomial_size(),
private_compression_key.params.br_base_log,
private_compression_key.params.br_level,
params
compression_params
.packing_ks_glwe_dimension
.to_equivalent_lwe_dimension(params.packing_ks_polynomial_size),
.to_equivalent_lwe_dimension(compression_params.packing_ks_polynomial_size),
self.parameters().ciphertext_modulus(),
);

Expand All @@ -71,7 +76,7 @@ impl RadixClientKey {
&private_compression_key
.post_packing_ks_key
.as_lwe_secret_key(),
&self.as_ref().key.glwe_secret_key,
&std_cks.glwe_secret_key,
&mut bsk,
self.parameters().glwe_noise_distribution(),
&mut engine.encryption_generator,
Expand All @@ -84,7 +89,7 @@ impl RadixClientKey {

let cuda_decompression_key = CudaDecompressionKey {
blind_rotate_key,
lwe_per_glwe: params.lwe_per_glwe,
lwe_per_glwe: compression_params.lwe_per_glwe,
glwe_dimension: self.parameters().glwe_dimension(),
polynomial_size: self.parameters().polynomial_size(),
message_modulus: self.parameters().message_modulus(),
Expand Down
Loading
Loading