randomx_rs/test_utils.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
// Copyright 2019. The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. 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.
//
// 3. 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 HOLDER 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.
use crate::{RandomXCache, RandomXDataset, RandomXFlag, RandomXVM};
/// Fuzzing:
/// - `pub fn randomx_alloc_cache`
/// - `pub fn randomx_get_flags`
/// - `pub fn randomx_init_cache`
/// - `pub fn randomx_release_cache`
#[allow(clippy::needless_pass_by_value)] // This is required by the `QuickCheck` fuzzing framework
pub fn fuzz_randomx_alloc_cache(data: Vec<u8>) -> bool {
let flags = if data.is_empty() {
RandomXFlag::default()
} else {
match data[0] % 10 {
0 => RandomXFlag::get_recommended_flags(),
1 => RandomXFlag::FLAG_DEFAULT,
2 => RandomXFlag::FLAG_LARGE_PAGES,
3 => RandomXFlag::FLAG_HARD_AES,
4 => RandomXFlag::FLAG_FULL_MEM,
5 => RandomXFlag::FLAG_JIT,
6 => RandomXFlag::FLAG_SECURE,
7 => RandomXFlag::FLAG_ARGON2_SSSE3,
8 => RandomXFlag::FLAG_ARGON2_AVX2,
_ => RandomXFlag::FLAG_ARGON2,
}
};
let _unused = RandomXCache::new(flags, &data);
true
}
/// Fuzzing:
/// - `pub fn randomx_create_vm`
/// - `pub fn randomx_destroy_vm`
/// - `pub fn randomx_vm_set_cache`
/// - `pub fn randomx_alloc_cache`
/// - `pub fn randomx_get_flags`
/// - `pub fn randomx_init_cache`
/// - `pub fn randomx_release_cache`
#[allow(clippy::needless_pass_by_value)] // This is required by the `QuickCheck` fuzzing framework
pub fn fuzz_randomx_create_vm_with_cache_only(data: Vec<u8>) -> bool {
let flags = RandomXFlag::get_recommended_flags();
if let Ok(cache) = RandomXCache::new(flags, &data) {
if let Ok(mut vm) = RandomXVM::new(flags, Some(cache.clone()), None) {
let _unused = vm.reinit_cache(cache);
}
}
true
}
/// Fuzzing:
/// - `pub fn randomx_get_flags`
/// - `pub fn randomx_create_vm`
/// - `pub fn randomx_destroy_vm`
/// - `pub fn randomx_dataset_item_count`
/// - `pub fn randomx_alloc_cache`
/// - `pub fn randomx_init_cache`
/// - `pub fn randomx_release_cache`
/// - `pub fn randomx_alloc_dataset`
/// - `pub fn randomx_init_dataset`
/// - `pub fn randomx_release_dataset`
/// - `pub fn randomx_vm_set_cache`
/// - `pub fn randomx_vm_set_dataset`
/// - `pub fn randomx_dataset_item_count`
/// - `pub fn randomx_get_dataset_memory`
#[allow(clippy::needless_pass_by_value)] // This is required by the `QuickCheck` fuzzing framework
pub fn fuzz_randomx_create_vm_with_cache_and_dataset(data: Vec<u8>) -> bool {
let flags = RandomXFlag::get_recommended_flags();
if let Ok(cache) = RandomXCache::new(flags, &data) {
let start = if data.is_empty() { 0u32 } else { u32::from(data[0] % 3) };
if let Ok(dataset) = RandomXDataset::new(flags, cache.clone(), start) {
for _ in 0..100 {
let _unused = dataset.get_data();
}
if let Ok(mut vm) = RandomXVM::new(flags, Some(cache.clone()), Some(dataset.clone())) {
let _unused = vm.reinit_cache(cache);
let _unused = vm.reinit_dataset(dataset);
}
}
}
true
}
// Helper function to calculate hashes
fn calculate_hashes(hash_data: &[u8], vm: &mut RandomXVM, iterations: u8) {
let mut hash_data = hash_data.to_vec();
for _ in 0..iterations {
if hash_data.len() > 1 {
// Prepare hash input data
let hash_set_len = 12;
let mut hash_set = Vec::with_capacity(hash_set_len);
for _ in 0..hash_set_len {
let mut scratch_data = hash_data.clone();
let last = scratch_data.pop().unwrap();
scratch_data.insert(0, last);
hash_set.push(scratch_data);
}
let hash_set_ref = hash_set.iter().map(|v| v.as_slice()).collect::<Vec<&[u8]>>();
// Fuzz hash
let _unused = vm.calculate_hash(&hash_data);
let _unused = vm.calculate_hash_set(&hash_set_ref);
// Change data set
hash_data.pop();
} else {
let _unused = vm.calculate_hash(&hash_data);
let _unused = vm.calculate_hash_set(&[&hash_data]);
}
}
}
/// Fuzzing:
/// - `pub fn randomx_calculate_hash`
/// - `pub fn randomx_calculate_hash_last`
/// - `pub fn randomx_calculate_hash_first`
/// - `pub fn randomx_calculate_hash_next`
/// Secondary:
/// - `pub fn randomx_create_vm`
/// - `pub fn randomx_destroy_vm`
/// - `pub fn randomx_alloc_cache`
/// - `pub fn randomx_get_flags`
/// - `pub fn randomx_init_cache`
/// - `pub fn randomx_release_cache`
#[allow(clippy::needless_pass_by_value)] // This is required by the `QuickCheck` fuzzing framework
pub fn fuzz_randomx_vm_calculate_hash_with_cache_only(data: Vec<u8>) -> bool {
let flags = RandomXFlag::get_recommended_flags();
if let Ok(cache) = RandomXCache::new(flags, &data) {
let vm = RandomXVM::new(flags, Some(cache), None);
if let Ok(mut vm) = vm {
calculate_hashes(&data, &mut vm, 100);
}
}
true
}
/// Fuzzing:
/// - `pub fn randomx_calculate_hash`
/// - `pub fn randomx_calculate_hash_last`
/// - `pub fn randomx_calculate_hash_first`
/// - `pub fn randomx_calculate_hash_next`
/// Secondary:
/// - `pub fn randomx_create_vm`
/// - `pub fn randomx_destroy_vm`
/// - `pub fn randomx_alloc_cache`
/// - `pub fn randomx_get_flags`
/// - `pub fn randomx_init_cache`
/// - `pub fn randomx_release_cache`
/// - `pub fn randomx_alloc_dataset`
/// - `pub fn randomx_init_dataset`
/// - `pub fn randomx_dataset_item_count`
/// - `pub fn randomx_get_dataset_memory`
/// - `pub fn randomx_release_dataset`
#[allow(clippy::needless_pass_by_value)] // This is required by the `QuickCheck` fuzzing framework
pub fn fuzz_randomx_vm_calculate_hash_with_cache_and_dataset(data: Vec<u8>) -> bool {
let flags = RandomXFlag::get_recommended_flags();
if let Ok(cache) = RandomXCache::new(flags, &data) {
if let Ok(dataset) = RandomXDataset::new(flags, cache.clone(), 0) {
let vm = RandomXVM::new(flags, Some(cache), Some(dataset.clone()));
if let Ok(mut vm) = vm {
calculate_hashes(&data, &mut vm, 100);
}
}
}
true
}
#[cfg(test)]
mod tests {
use quickcheck::QuickCheck;
use crate::test_utils::{
fuzz_randomx_alloc_cache,
fuzz_randomx_create_vm_with_cache_and_dataset,
fuzz_randomx_create_vm_with_cache_only,
fuzz_randomx_vm_calculate_hash_with_cache_and_dataset,
fuzz_randomx_vm_calculate_hash_with_cache_only,
};
#[test]
fn test_fuzz_lib_alloc_cache() {
fuzz_randomx_alloc_cache(vec![]);
const TESTS: u64 = 25;
QuickCheck::new()
.min_tests_passed(TESTS)
.tests(TESTS)
.max_tests(TESTS)
.quickcheck(fuzz_randomx_alloc_cache as fn(Vec<u8>) -> bool);
}
#[test]
fn test_fuzz_randomx_create_vm_with_cache_only() {
fuzz_randomx_create_vm_with_cache_only(vec![]);
const TESTS: u64 = 25;
QuickCheck::new()
.min_tests_passed(TESTS)
.tests(TESTS)
.max_tests(TESTS)
.quickcheck(fuzz_randomx_create_vm_with_cache_only as fn(Vec<u8>) -> bool);
}
#[test]
fn test_fuzz_randomx_create_vm_with_cache_and_dataset() {
fuzz_randomx_create_vm_with_cache_and_dataset(vec![]);
const TESTS: u64 = 1;
QuickCheck::new()
.min_tests_passed(TESTS)
.tests(TESTS)
.max_tests(TESTS)
.quickcheck(fuzz_randomx_create_vm_with_cache_and_dataset as fn(Vec<u8>) -> bool);
}
#[test]
fn test_fuzz_randomx_vm_calculate_hash_with_cache_only() {
fuzz_randomx_vm_calculate_hash_with_cache_only(vec![]);
const TESTS: u64 = 3;
QuickCheck::new()
.min_tests_passed(TESTS)
.tests(TESTS)
.max_tests(TESTS)
.quickcheck(fuzz_randomx_vm_calculate_hash_with_cache_only as fn(Vec<u8>) -> bool);
}
#[test]
fn test_fuzz_randomx_vm_calculate_hash_with_cache_and_dataset() {
fuzz_randomx_vm_calculate_hash_with_cache_and_dataset(vec![]);
const TESTS: u64 = 1;
QuickCheck::new()
.min_tests_passed(TESTS)
.tests(TESTS)
.max_tests(TESTS)
.quickcheck(fuzz_randomx_vm_calculate_hash_with_cache_and_dataset as fn(Vec<u8>) -> bool);
}
}