yescrypt: lint and code cleanups (#665)

Author: tarcieri

yescrypt/src/common.rs

@@ -1,41 +1,26 @@
-#![allow(
-    dead_code,
-    mutable_transmutes,
-    non_camel_case_types,
-    non_snake_case,
-    non_upper_case_globals,
-    unused_assignments,
-    unused_mut
-)]
-
-pub(crate) unsafe fn blkcpy(mut dst: *mut u32, mut src: *const u32, mut count: usize) {
+pub(crate) unsafe fn blkcpy(dst: *mut u32, src: *const u32, count: usize) {
     dst.copy_from(src, count);
 }
 
-pub(crate) unsafe fn blkxor(mut dst: *mut u32, mut src: *const u32, mut count: usize) {
+pub(crate) unsafe fn blkxor(dst: *mut u32, src: *const u32, count: usize) {
     for i in 0..count {
         *dst.add(i) ^= *src.add(i);
     }
 }
 
-pub(crate) unsafe fn integerify(mut B: *const u32, mut r: usize) -> u64 {
-    let mut X: *const u32 = B.add(
+pub(crate) unsafe fn integerify(b: *const u32, r: usize) -> u64 {
+    let x: *const u32 = b.add(
         (2usize)
             .wrapping_mul(r)
             .wrapping_sub(1usize)
             .wrapping_mul(16usize),
     );
-    ((*X.add(13) as u64) << 32).wrapping_add(*X as u64)
-}
-
-unsafe fn memxor(mut dst: *mut u8, mut src: *mut u8, mut size: usize) {
-    for i in 0..size {
-        *dst.add(i) ^= *src.add(i);
-    }
+    ((*x.add(13) as u64) << 32).wrapping_add(*x as u64)
 }
 
 pub(crate) fn prev_power_of_two(mut x: u64) -> u64 {
-    let mut y = 0;
+    let mut y;
+
     loop {
         y = x & x.wrapping_sub(1);
         if y == 0 {

yescrypt/src/lib.rs

@@ -10,24 +10,18 @@
     //clippy::cast_possible_truncation,
     clippy::cast_possible_wrap,
     clippy::cast_precision_loss,
-    //clippy::cast_sign_loss,
+    clippy::cast_sign_loss,
     clippy::checked_conversions,
     clippy::implicit_saturating_sub,
     clippy::panic,
     clippy::panic_in_result_fn,
-    //missing_docs,
+    missing_docs,
     rust_2018_idioms,
     unused_lifetimes,
     unused_qualifications
 )]
 // Temporary lint overrides while C code is being translated
-#![allow(
-    clippy::cast_possible_wrap,
-    clippy::too_many_arguments,
-    clippy::toplevel_ref_arg,
-    clippy::unwrap_used,
-    unsafe_op_in_unsafe_fn
-)]
+#![allow(clippy::too_many_arguments, unsafe_op_in_unsafe_fn)]
 
 // Adapted from the yescrypt reference implementation available at:
 // <https://github.com/openwall/yescrypt>

yescrypt/src/params.rs

@@ -4,19 +4,44 @@ bitflags::bitflags! {
     /// Flags for controlling the operation of `yescrypt`.
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
     pub struct Flags: u32 {
-        const WORM                = 0x001;
-        const RW                  = 0x002;
-        const ROUNDS_3            = 0b000;
-        const ROUNDS_6            = 0x004;
-        const GATHER_4            = 0x010;
-        const SIMPLE_2            = 0x020;
-        const SBOX_12K            = 0x080;
+        /// Write once read many
+        const WORM = 0x001;
+
+        /// Read/write
+        const RW = 0x002;
+
+        /// 3 rounds
+        const ROUNDS_3 = 0b000;
+
+        /// 6 rounds
+        const ROUNDS_6 = 0x004;
+
+        /// Gather 4
+        const GATHER_4 = 0x010;
+
+        /// Simple 2
+        const SIMPLE_2 = 0x020;
+
+        /// SBox 12k
+        const SBOX_12K = 0x080;
+
+        /// Use shared preallocated memory
         const SHARED_PREALLOCATED = 0x10000;
-        const MODE_MASK           = 0x3;
-        const RW_FLAVOR_MASK      = 0x3fc;
-        const INIT_SHARED         = 0x01000000;
-        const ALLOC_ONLY          = 0x08000000;
-        const PREHASH             = 0x10000000;
+
+        /// Mode mask value
+        const MODE_MASK = 0x3;
+
+        /// Read/write flavor mask value
+        const RW_FLAVOR_MASK = 0x3fc;
+
+        /// Initialize shared memory
+        const INIT_SHARED = 0x01000000;
+
+        /// Allocate only
+        const ALLOC_ONLY = 0x08000000;
+
+        /// Prehash
+        const PREHASH = 0x10000000;
     }
 }