      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

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.

    // Parity is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU General Public License for more details.

    // You should have received a copy of the GNU General Public License
    // along with Parity.  If not, see <http://www.gnu.org/licenses/>.

    use std::cmp::max;

    const MIN_BC_CACHE_MB: u32 = 4;
    const MIN_DB_CACHE_MB: u32 = 2;
    const MIN_BLOCK_QUEUE_SIZE_LIMIT_MB: u32 = 16;
    const DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB: u32 = 50;
    const DEFAULT_TRACE_CACHE_SIZE: u32 = 20;
    const DEFAULT_STATE_CACHE_SIZE: u32 = 25;

    /// Configuration for application cache sizes.
    /// All	values are represented in MB.
    #[derive(Debug, PartialEq)]
    pub struct CacheConfig {
    	/// Size of rocksDB cache. Almost all goes to the state column.
    	db: u32,
    	/// Size of blockchain cache.
    	blockchain: u32,
    	/// Size of transaction queue cache.
    	queue: u32,
    	/// Size of traces cache.
    	traces: u32,
    	/// Size of the state cache.
    	state: u32,
    }

    impl Default for CacheConfig {
    	fn default() -> Self {
    		CacheConfig::new(64, 8, DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB, DEFAULT_STATE_CACHE_SIZE)
    	}
    }

    impl CacheConfig {
    	/// Creates new cache config with cumulative size equal `total`.
    	pub fn new_with_total_cache_size(total: u32) -> Self {
    		CacheConfig {
    			db: total * 7 / 10,
    			blockchain: total / 10,
    			queue: DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB,
    			traces: DEFAULT_TRACE_CACHE_SIZE,
    			state: total * 2 / 10,
    		}
    	}

    	/// Creates new cache config with gitven details.
    	pub fn new(db: u32, blockchain: u32, queue: u32, state: u32) -> Self {
    		CacheConfig {
    			db: db,
    			blockchain: blockchain,
    			queue: queue,
    			traces: DEFAULT_TRACE_CACHE_SIZE,
    			state: state,
    		}
    	}

    	/// Size of db cache for blockchain.
    	pub fn db_blockchain_cache_size(&self) -> u32 {
    		max(MIN_DB_CACHE_MB, self.db / 4)
    	}

    	/// Size of db cache for state.
    	pub fn db_state_cache_size(&self) -> u32 {
    		max(MIN_DB_CACHE_MB, self.db * 3 / 4)
    	}

    	/// Size of block queue size limit
    	pub fn queue(&self) -> u32 {
    		max(self.queue, MIN_BLOCK_QUEUE_SIZE_LIMIT_MB)
    	}

    	/// Size of the blockchain cache.
    	pub fn blockchain(&self) -> u32 {
    		max(self.blockchain, MIN_BC_CACHE_MB)
    	}

    	/// Size of the traces cache.
    	pub fn traces(&self) -> u32 {
    		self.traces
    	}

    	/// Size of the state cache.
    	pub fn state(&self) -> u32 {
    		self.state * 3 / 4
    	}

    	/// Size of the jump-tables cache.
    	pub fn jump_tables(&self) -> u32 {
    		self.state / 4
    	}
    }

    #[cfg(test)]
    mod tests {
    	use super::CacheConfig;

    	#[test]
    	fn test_cache_config_constructor() {
    		let config = CacheConfig::new_with_total_cache_size(200);
    		assert_eq!(config.db, 140);
    		assert_eq!(config.blockchain(), 20);
    		assert_eq!(config.queue(), 50);
    		assert_eq!(config.state(), 30);
    		assert_eq!(config.jump_tables(), 10);
    	}

    	#[test]
    	fn test_cache_config_db_cache_sizes() {
    		let config = CacheConfig::new_with_total_cache_size(400);
    		assert_eq!(config.db, 280);
    		assert_eq!(config.db_blockchain_cache_size(), 70);
    		assert_eq!(config.db_state_cache_size(), 210);
    	}

    	#[test]
    	fn test_cache_config_default() {
    		assert_eq!(CacheConfig::default(),
    			CacheConfig::new(64, 8, super::DEFAULT_BLOCK_QUEUE_SIZE_LIMIT_MB, super::DEFAULT_STATE_CACHE_SIZE));
    	}
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)