14 releases

0.7.1 Aug 27, 2024
0.7.0 Jun 8, 2023
0.6.0 Apr 14, 2023
0.5.2 Mar 3, 2023
0.1.2 Nov 16, 2021

#181 in Cryptography

Download history 2431/week @ 2024-07-17 1620/week @ 2024-07-24 2768/week @ 2024-07-31 1714/week @ 2024-08-07 2013/week @ 2024-08-14 1980/week @ 2024-08-21 1838/week @ 2024-08-28 1987/week @ 2024-09-04 3057/week @ 2024-09-11 3451/week @ 2024-09-18 1870/week @ 2024-09-25 1528/week @ 2024-10-02 1508/week @ 2024-10-09 1486/week @ 2024-10-16 1302/week @ 2024-10-23 1291/week @ 2024-10-30

5,972 downloads per month
Used in 54 crates (3 directly)

MIT/Apache

130KB
2.5K SLoC

Rust 2K SLoC // 0.1% comments OpenCL 803 SLoC // 0.0% comments

CUDA/OpenCL code generator for finite-field arithmetic over prime fields and elliptic curve arithmetic constructed with Rust.

There is also support for Fast Fourier Transform and Multiexponentiation.

This crate usually creates GPU kernels at compile-time. CUDA generates a fatbin, which OpenCL only generates the source code, which is then compiled at run-time.

In order to make things easier to use, there are helper functions available. You would put some code into build.rs, that generates the kernels, and some code into your library which then consumes those generated kernels. The kernels will be directly embedded into your program/library. If something goes wrong, you will get an error at compile-time.

In this example we will make use of the FFT functionality. Add to your build.rs:

use blstrs::Scalar;
use ec_gpu_gen::SourceBuilder;

let source_builder = SourceBuilder::new().add_fft::<Scalar>();
ec_gpu_gen::generate(&source_builder);

The ec_gpu_gen::generate() takes care of the actual code generation/compilation. It will automatically create a CUDA and/or OpenCL kernel. It will define two environment variables, which are meant for internal use. _EC_GPU_CUDA_KERNEL_FATBIN that points to the compiled CUDA kernel, and _EC_GPU_OPENCL_KERNEL_SOURCE that points to the generated OpenCL source.

Those variables are then picked up by the ec_gpu_gen::program!() macro, which generates a program, for a given GPU device. Using FFT within your library would then look like this:

use blstrs::Scalar;
use ec_gpu_gen::{
    rust_gpu_tools::Device,
};

let devices = Device::all();
let programs = devices
    .iter()
    .map(|device| ec_gpu_gen::program!(device))
    .collect::<Result<_, _>>()
    .expect("Cannot create programs!");

let mut kern = FftKernel::<Scalar>::create(programs).expect("Cannot initialize kernel!");
kern.radix_fft_many(&mut [&mut coeffs], &[omega], &[log_d]).expect("GPU FFT failed!");

Feature flags

CUDA and OpenCL are supprted, each be enabled with the cuda and opencl feature flags.

Dependencies

~3–11MB
~131K SLoC