Merge pull request #1 from robinhundt/add-github-actions

Add github actions

Author: robinhundt

.github/workflows/bench.yml

@@ -0,0 +1,34 @@
+name: bench
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  benchmarks:
+    runs-on: "ubicloud-standard-4"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@master
+        id: toolchain
+        with:
+          toolchain: stable
+      - name: Override default toolchain
+        run: rustup override set ${{steps.toolchain.outputs.name}}
+      - run: cargo --version
+      - name: Install bencher
+        uses: bencherdev/bencher@main
+      - name: Run benchmarks
+        run: |
+          bencher run \
+          --project cryprot \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch main \
+          --testbed ubicloud-standard-4 \
+          --github-actions '${{ secrets.GITHUB_TOKEN }}' \
+          'cargo bench'

.github/workflows/pull_request.yml

@@ -0,0 +1,65 @@
+name: Pull Request
+
+on:
+  pull_request:
+    branches:
+      - "main"
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Test
+    runs-on: "${{ matrix.os }}"
+    strategy:
+      matrix:
+        os: [ "ubuntu-latest", "windows-latest", "macos-14" ]
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@master
+        id: toolchain
+        with:
+          toolchain: nightly-2025-02-14
+          components: "rustfmt, miri"
+      - name: Override default toolchain
+        run: rustup override set ${{steps.toolchain.outputs.name}}
+      - run: cargo --version
+      - name: Install NASM
+        if: ${{ matrix.os == 'windows-latest' }}
+        uses: ilammy/setup-nasm@v1
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Run tests
+        run: cargo test --workspace --verbose --all-features --no-fail-fast
+      - name: Run miri test
+        env:
+          RUSTFLAGS: "-C target-cpu=native"
+          MIRIFLAGS: "-Zmiri-disable-isolation"
+        run: cargo miri t -p cryprot-codes -p cryprot-core 
+  lint:
+    name: Lint
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@master
+        id: toolchain
+        with:
+          toolchain: nightly-2025-02-14
+          components: "clippy, rustfmt"
+      - name: Override default toolchain
+        run: rustup override set ${{steps.toolchain.outputs.name}}
+      - run: cargo --version
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Check formatting
+        run: cargo fmt --all --check
+      - name: Check Clippy
+        run: cargo clippy --workspace --all-features --examples -- -D warnings

.github/workflows/push.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [ "push" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  Test:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@master
+        id: toolchain
+        with:
+          toolchain: nightly-2025-02-14
+      - name: Override default toolchain
+        run: rustup override set ${{steps.toolchain.outputs.name}}
+      - run: cargo --version
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Test
+        run: cargo test --workspace --verbose --all-features --no-fail-fast

.github/workflows/rustdoc.yml

@@ -0,0 +1,63 @@
+name: rustdoc
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  # Build job
+  build:
+    runs-on: "ubuntu-latest"
+    env:
+      # deny rustdoc warnings
+      RUSTDOCFLAGS: -D warnings
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install nightly
+        uses: dtolnay/rust-toolchain@master
+        id: toolchain
+        with:
+          toolchain: nightly-2025-02-14
+      - name: Override default toolchain
+        run: rustup override set ${{steps.toolchain.outputs.name}}
+      - run: cargo --version
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+      - name: Create Docs
+        run: cargo doc --workspace --verbose --all-features --no-deps -Zunstable-options -Zrustdoc-scrape-examples
+      - name: Fix permissions
+        run: |
+          chmod -c -R +rX "target/doc/" | while read line; do
+            echo "::warning title=Invalid file permissions automatically fixed::$line"
+          done
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "target/doc/"
+  
+  # Deploy job
+  deploy:
+    # Add a dependency to the build job
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
+

cryprot-codes/Cargo.toml

@@ -23,10 +23,12 @@ cpufeatures.workspace = true
 cryprot-core.workspace = true
 fastdivide.workspace = true
 hybrid-array = { workspace = true }
-libote-codes = { version = "0.1.0", git = "https://github.com/robinhundt/libote-codes.git", optional = true }
 rand.workspace = true
 seq-macro.workspace = true
 
+[target.'cfg(target_os = "linux")'.dependencies]
+libote-codes = { version = "0.1.0", git = "https://github.com/robinhundt/libote-codes.git", optional = true }
+
 [dev-dependencies]
 criterion.workspace = true
 

cryprot-codes/benches/bench.rs

@@ -32,7 +32,7 @@ fn criterion_benchmark(c: &mut Criterion) {
         });
     }
 
-    #[cfg(feature = "bench-libote")]
+    #[cfg(all(feature = "bench-libote", target_os = "linux"))]
     {
         use cryprot_codes::ex_conv::ExConvCodeConfig;
 

cryprot-codes/src/ex_conv.rs

@@ -269,7 +269,7 @@ mod tests {
     use bytemuck::cast_slice_mut;
     use cryprot_core::block::Block;
     #[cfg(feature = "libote-compat")]
-    use rand::{rngs::StdRng, RngCore, SeedableRng};
+    use rand::{RngCore, SeedableRng, rngs::StdRng};
 
     use super::*;
 
@@ -321,7 +321,7 @@ mod tests {
         assert_eq!(code.parity_cols(), code_size);
     }
 
-    #[cfg(feature = "libote-compat")]
+    #[cfg(all(feature = "libote-compat", target_os = "linux"))]
     #[test]
     fn test_compare_to_libote() {
         let message_size = 200;
@@ -347,7 +347,7 @@ mod tests {
         }
     }
 
-    #[cfg(feature = "libote-compat")]
+    #[cfg(all(feature = "libote-compat", target_os = "linux"))]
     #[test]
     fn test_compare_to_libote_bytes() {
         let message_size = 200;

cryprot-codes/src/ex_conv/expander.rs

@@ -129,7 +129,7 @@ impl ExpanderCode {
 #[cfg(test)]
 mod tests {
     use bytemuck::cast_slice_mut;
-    use rand::{rngs::StdRng, RngCore, SeedableRng};
+    use rand::{RngCore, SeedableRng, rngs::StdRng};
 
     use super::*;
 

cryprot-codes/src/ex_conv/expander_modd.rs

@@ -1,6 +1,6 @@
 use std::mem::{self};
 
-use bytemuck::cast_slice_mut;
+use bytemuck::{cast_slice, cast_slice_mut};
 use cryprot_core::{Block, utils::log2_ceil};
 use fastdivide::DividerU64;
 
@@ -13,7 +13,7 @@ pub(crate) struct ExpanderModd {
     rng: FastAesRng,
     mod_val: u64,
     idx: usize,
-    vals: Box<[u64; RAND_U64_VALS]>,
+    vals: Box<[Block; RAND_BLOCKS]>,
     mod_divider: DividerU64,
     m_is_pow2: bool,
     m_pow2_mask: u64,
@@ -22,11 +22,12 @@ pub(crate) struct ExpanderModd {
 
 impl ExpanderModd {
     pub(crate) fn new(seed: Block, m: u64) -> Self {
+        let vals = Box::new([Block::ZERO; RAND_BLOCKS]);
         let mut expander = ExpanderModd {
             rng: FastAesRng::new(seed),
             mod_val: 0,
             idx: 0,
-            vals: Box::new([0; RAND_U64_VALS]),
+            vals,
             mod_divider: DividerU64::divide_by(1), // Dummy initial value
             m_is_pow2: false,
             m_pow2_mask: 0,
@@ -51,12 +52,14 @@ impl ExpanderModd {
 
     #[inline(always)]
     pub(crate) fn get(&mut self) -> usize {
-        if self.idx == self.vals.len() {
+        // RAND_U64_VALS is equal to len of vals: &[u64]
+        if self.idx == RAND_U64_VALS {
             self.refill();
         }
-        // SAFETY: self.idx is always < self.vals.len(). If self.idx == self.vals.len(),
-        // it is set to to 0 in self.refill()
-        let val = unsafe { *self.vals.get_unchecked(self.idx) };
+        let vals: &[u64] = cast_slice(&self.vals[..]);
+        // SAFETY: self.idx is always < RAND_U64_VALS == vals.len(). If self.idx ==
+        // RAND_U64_VALS, it is set to to 0 in self.refill()
+        let val = unsafe { *vals.get_unchecked(self.idx) };
         self.idx += 1;
         val as usize
     }
@@ -67,14 +70,15 @@ impl ExpanderModd {
         self.rng.refill();
 
         let src = self.rng.blocks();
-        let dest: &mut [Block] = cast_slice_mut(&mut self.vals[..]);
+        let dest: &mut [Block] = &mut self.vals[..];
         if self.m_is_pow2 {
             for (dest, src) in dest.iter_mut().zip(src) {
                 *dest = *src & self.m_pow2_mask_blk;
             }
         } else {
             dest.copy_from_slice(src);
-            for chunk in self.vals.chunks_mut(32) {
+            let vals: &mut [u64] = cast_slice_mut(&mut self.vals[..]);
+            for chunk in vals.chunks_mut(32) {
                 Self::do_mod32(chunk, &self.mod_divider, self.mod_val);
             }
         }

cryprot-codes/src/ex_conv/fast_aes_rng.rs

@@ -1,5 +1,5 @@
 use bytemuck::{cast_mut, cast_ref, cast_slice, cast_slice_mut};
-use cryprot_core::{aes_rng::AesRng, Block};
+use cryprot_core::{Block, aes_rng::AesRng};
 use rand::{RngCore, SeedableRng};
 
 // Simple PRNG implementation for the accumulator