refactor(crc32): use faster implement

Author: LongYinan

README.md

@@ -0,0 +1,3 @@
+# node-rs
+
+When `NodeJS` meet `Rust` = 🚀

package.json

@@ -55,6 +55,9 @@
     ],
     "*.@(yml|yaml)": [
       "prettier --parser yaml --write"
+    ],
+    "*.md": [
+      "prettier --parser markdown --write"
     ]
   },
   "prettier": {

packages/crc32/COPYING

@@ -0,0 +1,27 @@
+Copyright 2011, The Snappy-Rust Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/crc32/Cargo.toml

@@ -10,7 +10,6 @@ crate-type = ["cdylib"]
 [dependencies]
 napi-rs = { version = "0.2" }
 napi-rs-derive = { version = "0.1" }
-crc32c = "0.4"
 crc32fast = "1.2"
 
 [build-dependencies]

packages/crc32/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020-present LongYinan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

packages/crc32/README.md

@@ -1,11 +1,21 @@
-# `base64`
+# `@node-rs/crc32`
 
-> TODO: description
+Fastest `crc32` implement in `NodeJS`
 
-## Usage
+## API
 
+```ts
+export function crc32(input: Buffer, crc?: number): number
+export function crc32c(input: Buffer, crc?: number): number
 ```
-const base64 = require('base64');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```ts
+const { crc32 } = require('@node-rs/crc32')
+const { readFileSync } = require('fs')
+
+const content = readFileSync('./avatar.png')
+
+crc32(content)
 ```

packages/crc32/benchmark/calculate.js

@@ -0,0 +1,95 @@
+const { Suite } = require('benchmark')
+const Sse4Crc32 = require('sse4_crc32')
+const { crc32: crc32Node } = require('crc')
+const chalk = require('chalk')
+
+const { crc32c, crc32 } = require('../crc32.node')
+
+const TEST_BUFFER = Buffer.from(`Lorem ipsum dolor sit amet, consectetur
+adipiscing elit. Morbi mollis cursus metus vel tristique. Proin congue massa
+massa, a malesuada dolor ullamcorper a. Nulla eget leo vel orci venenatis
+placerat. Donec semper condimentum justo, vel sollicitudin dolor consequat id.
+Nunc sed aliquet felis, eget congue nisi. Mauris eu justo suscipit, elementum
+turpis ut, molestie tellus. Mauris ornare rutrum fringilla. Nulla dignissim
+luctus pretium. Nullam nec eros hendrerit sapien pellentesque sollicitudin.
+Integer eget ligula dui. Mauris nec cursus nibh. Nunc interdum elementum leo, eu
+sagittis eros sodales nec. Duis dictum nulla sed tincidunt malesuada. Quisque in
+vulputate sapien. Sed sit amet tellus a est porta rhoncus sed eu metus. Mauris
+non pulvinar nisl, volutpat luctus enim. Suspendisse est nisi, sagittis at risus
+quis, ultricies rhoncus sem. Donec ullamcorper purus eget sapien facilisis, eu
+eleifend felis viverra. Suspendisse elit neque, semper aliquet neque sed,
+egestas tempus leo. Duis condimentum turpis duis.`)
+
+const initialCrc32 = crc32Node(TEST_BUFFER)
+const initialCrc32c = Sse4Crc32.calculate(TEST_BUFFER)
+
+console.assert(crc32(TEST_BUFFER), initialCrc32)
+console.assert(crc32c(TEST_BUFFER), initialCrc32c)
+
+const suite = new Suite('crc32c without initial crc')
+
+suite
+  .add('SIMD + NAPI', () => {
+    crc32c(TEST_BUFFER)
+  })
+  .add('sse4_crc32', () => {
+    Sse4Crc32.calculate(TEST_BUFFER)
+  })
+  .on('cycle', function (event) {
+    console.info(String(event.target))
+  })
+  .on('complete', function () {
+    console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+  })
+  .run()
+
+const suite2 = new Suite('crc32c with initial crc')
+
+suite2
+  .add('SIMD + NAPI', () => {
+    crc32c(TEST_BUFFER, initialCrc32c)
+  })
+  .add('sse4_crc32', () => {
+    Sse4Crc32.calculate(TEST_BUFFER, initialCrc32c)
+  })
+  .on('cycle', function (event) {
+    console.info(String(event.target))
+  })
+  .on('complete', function () {
+    console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+  })
+  .run()
+
+const suite3 = new Suite('crc32 without initial crc')
+
+suite3
+  .add('SIMD + NAPI', () => {
+    crc32(TEST_BUFFER)
+  })
+  .add('Node crc', () => {
+    crc32Node(TEST_BUFFER)
+  })
+  .on('cycle', function (event) {
+    console.info(String(event.target))
+  })
+  .on('complete', function () {
+    console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+  })
+  .run()
+
+const suite4 = new Suite('crc32 with initial crc')
+
+suite4
+  .add('SIMD + NAPI', () => {
+    crc32(TEST_BUFFER, initialCrc32)
+  })
+  .add('Node crc32', () => {
+    crc32Node(TEST_BUFFER, initialCrc32)
+  })
+  .on('cycle', function (event) {
+    console.info(String(event.target))
+  })
+  .on('complete', function () {
+    console.info(`${this.name} bench suite: Fastest is ${chalk.green(this.filter('fastest').map('name'))}`)
+  })
+  .run()

packages/crc32/benchmark/crc32.js

@@ -1,9 +1,79 @@
 extern crate napi_build;
 
 use std::env;
+use std::fs::File;
+use std::io::{self, Write};
+use std::path::{Path, PathBuf};
 
-fn main() {
+type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
+
+const CASTAGNOLI_POLY: u32 = 0x82f63b78;
+
+fn main() -> Result<()> {
   napi_build::setup();
 
-  env::set_var("RUSTFLAGS", "-C target-feature=+sse4.2");
+  let out_dir = match env::var_os("OUT_DIR") {
+    None => return Err(From::from("OUT_DIR environment variable not defined")),
+    Some(out_dir) => PathBuf::from(out_dir),
+  };
+  write_crc_tables(&out_dir)?;
+
+  Ok(())
+}
+
+fn write_crc_tables(out_dir: &Path) -> Result<()> {
+  let out_path = out_dir.join("crc32_table.rs");
+  let mut out = io::BufWriter::new(File::create(out_path)?);
+
+  let table = make_table(CASTAGNOLI_POLY);
+  let table16 = make_table16(CASTAGNOLI_POLY);
+
+  writeln!(out, "pub const TABLE: [u32; 256] = [")?;
+  for &x in table.iter() {
+    writeln!(out, "    {},", x)?;
+  }
+  writeln!(out, "];\n")?;
+
+  writeln!(out, "pub const TABLE16: [[u32; 256]; 16] = [")?;
+  for table in table16.iter() {
+    writeln!(out, "    [")?;
+    for &x in table.iter() {
+      writeln!(out, "        {},", x)?;
+    }
+    writeln!(out, "    ],")?;
+  }
+  writeln!(out, "];")?;
+
+  out.flush()?;
+
+  Ok(())
+}
+
+fn make_table16(poly: u32) -> [[u32; 256]; 16] {
+  let mut tab = [[0; 256]; 16];
+  tab[0] = make_table(poly);
+  for i in 0..256 {
+    let mut crc = tab[0][i];
+    for j in 1..16 {
+      crc = (crc >> 8) ^ tab[0][crc as u8 as usize];
+      tab[j][i] = crc;
+    }
+  }
+  tab
+}
+
+fn make_table(poly: u32) -> [u32; 256] {
+  let mut tab = [0; 256];
+  for i in 0u32..256u32 {
+    let mut crc = i;
+    for _ in 0..8 {
+      if crc & 1 == 1 {
+        crc = (crc >> 1) ^ poly;
+      } else {
+        crc >>= 1;
+      }
+    }
+    tab[i as usize] = crc;
+  }
+  tab
 }

packages/crc32/build.rs

@@ -18,7 +18,9 @@
   "files": [
     "index.js",
     "index.d.ts",
-    "index.*.node"
+    "index.*.node",
+    "LICENSE",
+    "COPYING"
   ],
   "repository": {
     "type": "git",