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

/*
 * Copyright 2024 Fluence Labs Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use crate::bindings::cache::*;
use crate::flags::RandomXFlags;
use crate::try_alloc;
use crate::RResult;

pub struct Cache {
    cache: *mut randomx_cache,
}

impl Cache {
    /// Creates RandomX cache with the provided global_nonce.
    /// Flags is any combination of these 2 flags (each flag can be set or not set):
    ///  - RANDOMX_FLAG_LARGE_PAGES - allocate memory in large pages
    ///  - RANDOMX_FLAG_JIT - create cache structure with JIT compilation support; this makes
    ///                                     subsequent Dataset initialization faster
    /// Optionally, one of these two flags may be selected:
    ///  - RANDOMX_FLAG_ARGON2_SSSE3 - optimized Argon2 for CPUs with the SSSE3 instruction set
    ///                                makes subsequent cache initialization faster
    ///   - RANDOMX_FLAG_ARGON2_AVX2 - optimized Argon2 for CPUs with the AVX2 instruction set
    ///                                makes subsequent cache initialization faster
    pub fn new(global_nonce: &[u8], flags: RandomXFlags) -> RResult<Self> {
        let cache = try_alloc!(
            randomx_alloc_cache(flags.bits()),
            crate::RandomXError::CacheAllocationFailed { flags }
        );

        let mut cache = Cache { cache };
        cache.reinit(global_nonce);
        Ok(cache)
    }

    /// Initializes the cache memory using the provided global nonce value.
    /// Does nothing if called with the same value again.
    pub fn reinit(&mut self, global_nonce: &[u8]) {
        unsafe {
            randomx_init_cache(
                self.cache,
                global_nonce.as_ptr() as *const std::ffi::c_void,
                global_nonce.len(),
            )
        };
    }

    pub(crate) fn raw(&self) -> *mut randomx_cache {
        self.cache
    }
}

impl Drop for Cache {
    fn drop(&mut self) {
        unsafe { randomx_release_cache(self.cache) }
    }
}