Add some script to test the performance of different hash types

Author: joii2020

README.md

@@ -1,2 +1,17 @@
 # quantum-resistant-lock-script
 Qantum resistant lock script on CKB, using SPHINCS+
+
+
+## Performance
+Use items for tests/sphincsplus/optimization/run-all-optimization.sh
+
+|               |  128s bit  |  256s bit |
+| ------------- | ---------- | --------- |
+|   pubkey size |       32   |       64  |
+|     sign size |     7888   |    29824  |
+|  shake simple |    16.9M   |    37.1M  |
+|  shake robust |    34.3M   |    73.2M  |
+|   sha2 simple |    10.7M   |    24.7M  |
+|   sha2 robust |    22.5M   |    60.4M  |
+| haraka simple |    27.5M   |    60.4M  |
+| haraka robust |    45.7M   |   102.8M  |

tests/sphincsplus/optimization/Makefile

@@ -5,7 +5,7 @@ LD := $(TARGET)gcc
 PARAMS = sphincs-shake-256f
 THASH = robust
 
-CFLAGS := -fPIC -O3 -fno-builtin-printf -fno-builtin-memcmp -nostdinc -nostartfiles -fvisibility=hidden -fdata-sections -ffunction-sections -nostdlib -Wno-nonnull-compare -DCKB_VM -DCKB_DECLARATION_ONLY
+CFLAGS := -fPIC -O3 -fno-builtin-printf -fno-builtin-memcmp -nostdinc -nostartfiles -fvisibility=hidden -fdata-sections -ffunction-sections -nostdlib -Wno-nonnull-compare -DCKB_VM -DCKB_DECLARATION_ONLY -g -DCKB_C_STDLIB_PRINTF
 LDFLAGS := -fdata-sections -ffunction-sections
 
 # Using a new version of gcc will have a warning of ckb-c-stdlib
@@ -72,12 +72,13 @@ BUILDER_DOCKER := nervos/ckb-riscv-gnu-toolchain@sha256:7601a814be2595ad471288fe
 all: build/verify
 
 all-via-docker:
-	docker run --rm -v `pwd`:/code ${BUILDER_DOCKER} bash -c "cd /code && make"
+	cd ../../../ && docker run --rm -v `pwd`:/code ${BUILDER_DOCKER} bash -c "cd /code/tests/sphincsplus/optimization && make PARAMS=$(PARAMS) THASH=$(THASH)"
 
 build/verify: optimization-sphincsplus.c $(SOURCES) $(HEADERS)
 	$(CC) $(CFLAGS) -o $@ $(SOURCES) $<
 
 run: build/verify
+	export RUST_LOG=debug
 	ckb-debugger --bin $< --max-cycles=10000000000
 
 FLAME_GRAPH_DIR := ~/code/tmp/FlameGraph/

tests/sphincsplus/optimization/optimization-sphincsplus.c

@@ -23,6 +23,8 @@ int main() {
     return 2;
   }
 
-  printf("Done");
+  printf("PubKey size: %d, Sign size: %d\n", sizeof(G_TEST_DATA_PUB_KEY),
+         sizeof(G_TEST_DATA_SIGN));
+  // printf("Done");
   return 0;
 }

tests/sphincsplus/optimization/run-all-optimization.sh

@@ -0,0 +1,33 @@
+workdir=$(
+  cd $(dirname $0)
+  pwd
+)
+
+cd $workdir
+
+HASH_NAMES="shake sha2 haraka"
+HASH_SIZES="128 256"
+HASH_OPTIONS="s"
+THASHS="simple robust"
+for HASH_NAME in ${HASH_NAMES[@]}; do
+  for HASH_SIZE in ${HASH_SIZES[@]}; do
+    for HASH_OPTION in ${HASH_OPTIONS[@]}; do
+      for THASH in ${THASHS[@]}; do
+        PARAMS="sphincs-$HASH_NAME-$HASH_SIZE$HASH_OPTION"
+        echo "-----------------------------------------------"
+        echo $PARAMS $THASH
+
+        make clean > /dev/null
+        make all-via-docker PARAMS=$PARAMS THASH=$THASH > /dev/null
+        ckb-debugger --bin build/verify --max-cycles=10000000000
+        
+        if (($? == 0)); then
+          echo "success"
+        else
+          exit 1
+        fi
+
+      done
+    done
+  done
+done

tests/sphincsplus_rust/examples/run_base.rs

@@ -11,6 +11,7 @@ pub const MAX_CYCLES: u64 = std::u64::MAX;
 
 fn main() {
     let mut config = TestConfig::new();
+    config.print_time = true;
 
     let mut dummy = DummyDataLoader::new();
 
@@ -23,5 +24,5 @@ fn main() {
     verifier.set_debug_printer(debug_printer);
     let verify_result = verifier.verify(MAX_CYCLES);
     let res = verify_result.expect("pass verification");
-    println!("cycles: {}", res);
+    println!("cycles: {} ({:.2?}M)", res, (res as f64) / 1024.0 / 1024.0);
 }

tests/sphincsplus_rust/run_example.sh

@@ -0,0 +1,36 @@
+if [ ! -n "$1" ] ;then
+  HASH_NAME="shake"
+  HASH_SIZE="128"
+  THASH="robust"
+  HASH_OPTION="s"
+else
+  HASH_NAME=$1
+  HASH_SIZE=$2
+  THASH=$3
+  HASH_OPTION=$4
+fi
+PARAMS="sphincs-$HASH_NAME-$HASH_SIZE$HASH_OPTION"
+
+#!/bin/bash
+workdir=$(
+  cd $(dirname $0)/../../
+  pwd
+)
+
+cd $workdir
+
+rm -rf build/*
+mkdir -p build
+
+make all-via-docker PARAMS=$PARAMS THASH=$THASH > /dev/null
+if (($? != 0)); then
+  exit 1
+fi
+
+cd tests/sphincsplus_rust
+cargo clean > /dev/null
+cargo build --examples --no-default-features --features "$HASH_NAME hash_$HASH_SIZE hash_options_$HASH_OPTION thashes_$THASH" > /dev/null  2>&1
+./target/debug/examples/run_base
+if (($? != 0)); then
+  exit 1
+fi

tests/sphincsplus_rust/run_rust.sh

@@ -1,13 +1,15 @@
 if [ ! -n "$1" ] ;then
-  PARAMS="sphincs-shake-256f"
+  HASH_NAME="shake"
+  HASH_SIZE="256"
   THASH="robust"
+  HASH_OPTION="f"
 else
   HASH_NAME=$1
   HASH_SIZE=$2
   THASH=$3
   HASH_OPTION=$4
-  PARAMS="sphincs-$HASH_NAME-$HASH_SIZE$HASH_OPTION"
 fi
+PARAMS="sphincs-$HASH_NAME-$HASH_SIZE$HASH_OPTION"
 
 #!/bin/bash
 workdir=$(
@@ -29,7 +31,7 @@ fi
 
 cd tests/sphincsplus_rust
 cargo clean
-cargo test
+cargo test --no-default-features --features "$HASH_NAME hash_$HASH_SIZE hash_options_$HASH_OPTION thashes_$THASH"
 if (($? == 0)); then
   echo "success"
 else

tests/sphincsplus_rust/src/utils.rs

@@ -28,6 +28,7 @@ pub struct TestConfig {
     pub pubkey_error: bool,
     pub message_error: bool,
     rng: ThreadRng,
+    pub print_time: bool,
 }
 
 impl TestConfig {
@@ -38,6 +39,7 @@ impl TestConfig {
             pubkey_error: false,
             message_error: false,
             rng: thread_rng(),
+            print_time: false,
         }
     }
 
@@ -187,14 +189,20 @@ pub fn sign_tx_by_input_group(
                     if config.message_error {
                         config.rng.fill(&mut message);
                     }
-                    // let start = std::time::Instant::now();
+                    let start = std::time::Instant::now();
                     let sign = Bytes::from(if config.sign_error {
                         config.gen_rand_buf(config.key.get_sign_len())
                     } else {
                         config.key.sign(&message)
                     });
+                    if config.print_time {
+                        println!(
+                            "sign time(native): {} us ({:.2?}s)",
+                            start.elapsed().as_micros(),
+                            start.elapsed().as_secs_f32()
+                        );
+                    }
 
-                    // println!("sign time(native): {} us", start.elapsed().as_micros());
                     sign
                 };