use std::sync::Arc; use crate::ffi_util::{from_cstr, opt_bytes_to_ptr}; use libc::{self, c_char, c_int}; use crate::{ffi, Error}; /// An Env is an interface used by the rocksdb implementation to access /// operating system functionality like the filesystem etc. Callers /// may wish to provide a custom Env object when opening a database to /// get fine gain control; e.g., to rate limit file system operations. /// /// All Env implementations are safe for concurrent access from /// multiple threads without any external synchronization. /// /// Note: currently, C API behinds C++ API for various settings. /// See also: `rocksdb/include/env.h` #[derive(Clone)] pub struct Env(pub(crate) Arc); pub(crate) struct EnvWrapper { pub(crate) inner: *mut ffi::rocksdb_env_t, } impl Drop for EnvWrapper { fn drop(&mut self) { unsafe { ffi::rocksdb_env_destroy(self.inner); } } } impl Env { pub fn version() -> String { unsafe { let ptr: *const c_char = ffi::rocksdb_version(); let s = from_cstr(ptr); s } } /// Returns default env pub fn new() -> Result { let env = unsafe { ffi::rocksdb_create_default_env() }; if env.is_null() { Err(Error::new("Could not create default env".to_owned())) } else { Ok(Self(Arc::new(EnvWrapper { inner: env }))) } } /// Returns encrypted env. the key must be a 32 bytes long array of u8 pub fn enc_env(key: [u8; 32]) -> Result { let env = unsafe { ffi::rocksdb_create_encrypted_env(opt_bytes_to_ptr(Some(&key))) }; if env.is_null() { Err(Error::new("Could not create encrypted env".to_owned())) } else { Ok(Self(Arc::new(EnvWrapper { inner: env }))) } } /// Returns a new environment that stores its data in memory and delegates /// all non-file-storage tasks to base_env. pub fn mem_env() -> Result { let env = unsafe { ffi::rocksdb_create_mem_env() }; if env.is_null() { Err(Error::new("Could not create mem env".to_owned())) } else { Ok(Self(Arc::new(EnvWrapper { inner: env }))) } } /// Sets the number of background worker threads of a specific thread pool for this environment. /// `LOW` is the default pool. /// /// Default: 1 pub fn set_background_threads(&mut self, num_threads: c_int) { unsafe { ffi::rocksdb_env_set_background_threads(self.0.inner, num_threads); } } /// Sets the size of the high priority thread pool that can be used to /// prevent compactions from stalling memtable flushes. pub fn set_high_priority_background_threads(&mut self, n: c_int) { unsafe { ffi::rocksdb_env_set_high_priority_background_threads(self.0.inner, n); } } /// Sets the size of the low priority thread pool that can be used to /// prevent compactions from stalling memtable flushes. pub fn set_low_priority_background_threads(&mut self, n: c_int) { unsafe { ffi::rocksdb_env_set_low_priority_background_threads(self.0.inner, n); } } /// Sets the size of the bottom priority thread pool that can be used to /// prevent compactions from stalling memtable flushes. pub fn set_bottom_priority_background_threads(&mut self, n: c_int) { unsafe { ffi::rocksdb_env_set_bottom_priority_background_threads(self.0.inner, n); } } /// Wait for all threads started by StartThread to terminate. pub fn join_all_threads(&mut self) { unsafe { ffi::rocksdb_env_join_all_threads(self.0.inner); } } /// Lowering IO priority for threads from the specified pool. pub fn lower_thread_pool_io_priority(&mut self) { unsafe { ffi::rocksdb_env_lower_thread_pool_io_priority(self.0.inner); } } /// Lowering IO priority for high priority thread pool. pub fn lower_high_priority_thread_pool_io_priority(&mut self) { unsafe { ffi::rocksdb_env_lower_high_priority_thread_pool_io_priority(self.0.inner); } } /// Lowering CPU priority for threads from the specified pool. pub fn lower_thread_pool_cpu_priority(&mut self) { unsafe { ffi::rocksdb_env_lower_thread_pool_cpu_priority(self.0.inner); } } /// Lowering CPU priority for high priority thread pool. pub fn lower_high_priority_thread_pool_cpu_priority(&mut self) { unsafe { ffi::rocksdb_env_lower_high_priority_thread_pool_cpu_priority(self.0.inner); } } } unsafe impl Send for EnvWrapper {} unsafe impl Sync for EnvWrapper {}