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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
use crate::errors::RuntimeError;
use crate::internal_prelude::*;
use radix_engine_interface::types::*;
use radix_substate_store_interface::db_key_mapper::SubstateKeyContent;
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CallbackError<E, C> {
Error(E),
CallbackError(C),
}
impl<E> CallbackError<E, RuntimeError> {
pub fn to_runtime_error<F: FnOnce(E) -> RuntimeError>(self, f: F) -> RuntimeError {
match self {
CallbackError::Error(e) => f(e),
CallbackError::CallbackError(c) => c,
}
}
}
impl<E, C> CallbackError<E, C> {
pub fn map<N, F: FnOnce(E) -> N>(self, f: F) -> CallbackError<N, C> {
match self {
CallbackError::Error(e) => CallbackError::Error(f(e)),
CallbackError::CallbackError(c) => CallbackError::CallbackError(c),
}
}
}
pub type NodeSubstates = BTreeMap<PartitionNumber, BTreeMap<SubstateKey, IndexedScryptoValue>>;
pub enum TrackedSubstateInfo {
New,
Updated,
Unmodified,
}
/// The interface to be used during boot loading
/// This interface is different from the CommitableSubstateStore in
/// that these reads should not be tracked / costed since it will
/// cause a protocol break.
pub trait BootStore {
/// Read a substate from the store
fn read_boot_substate(
&self,
node_id: &NodeId,
partition_num: PartitionNumber,
substate_key: &SubstateKey,
) -> Option<IndexedScryptoValue>;
}
/// Represents the interface between Radix Engine and Track.
///
/// In practice, we will likely end up with only one implementation.
///
/// The trait here is for formalizing the interface and intended user flow.
pub trait CommitableSubstateStore {
/// Marks a substate as transient, or a substate which was never and will never be persisted
fn mark_as_transient(
&mut self,
node_id: NodeId,
partition_num: PartitionNumber,
substate_key: SubstateKey,
);
/// Inserts a node into the substate store.
///
/// Clients must ensure the `node_id` is new and unique; otherwise, the behavior is undefined.
///
/// # Panics
/// - If the partition is invalid
fn create_node<E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: NodeId,
node_substates: NodeSubstates,
on_io_access: &mut F,
) -> Result<(), E>;
fn get_tracked_substate_info(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
substate_key: &SubstateKey,
) -> TrackedSubstateInfo;
fn read_substate(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
substate_key: &SubstateKey,
) -> Option<&IndexedScryptoValue> {
self.get_substate(node_id, partition_num, substate_key, &mut |_| -> Result<
(),
(),
> {
Ok(())
})
.unwrap()
}
fn get_substate<E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
substate_key: &SubstateKey,
on_io_access: &mut F,
) -> Result<Option<&IndexedScryptoValue>, E>;
/// Inserts a substate into the substate store.
///
/// Clients must ensure the `node_id`/`partition_num` is a node which has been created; otherwise, the behavior
/// is undefined.
fn set_substate<E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: NodeId,
partition_num: PartitionNumber,
substate_key: SubstateKey,
substate_value: IndexedScryptoValue,
on_io_access: &mut F,
) -> Result<(), E>;
fn force_write(
&mut self,
node_id: &NodeId,
partition_num: &PartitionNumber,
substate_key: &SubstateKey,
);
/// Deletes a substate from the substate store.
///
/// Clients must ensure the `node_id`/`partition_num` is a node which has been created;
/// Clients must ensure this isn't called on a virtualized partition;
/// Otherwise, the behavior is undefined.
///
/// Returns tuple of substate and boolean which is true for the first database access.
fn remove_substate<E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
substate_key: &SubstateKey,
on_io_access: &mut F,
) -> Result<Option<IndexedScryptoValue>, E>;
/// Returns Substate Keys of maximum count for a given partition.
///
/// Clients must ensure that the SubstateKeyContent which the partition is
/// associated with is passed in. The returned SubstateKeys are guaranteed to be of
/// this type.
/// Otherwise, behavior is undefined.
///
/// Returns list of substate keys and database access info
fn scan_keys<K: SubstateKeyContent + 'static, E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
count: u32,
on_io_access: &mut F,
) -> Result<Vec<SubstateKey>, E>;
/// Removes substates of maximum count for a given partition.
///
/// Clients must ensure that the SubstateKeyContent which the partition is
/// associated with is passed in. The returned SubstateKeys are guaranteed to be of
/// this type.
/// Otherwise, behavior is undefined.
///
/// Returns list of removed substates with their associated keys and values, as well as database access info
fn drain_substates<K: SubstateKeyContent + 'static, E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
count: u32,
on_io_access: &mut F,
) -> Result<Vec<(SubstateKey, IndexedScryptoValue)>, E>;
/// Returns tuple of substate vector and boolean which is true for the first database access.
fn scan_sorted_substates<E, F: FnMut(IOAccess) -> Result<(), E>>(
&mut self,
node_id: &NodeId,
partition_num: PartitionNumber,
count: u32,
on_io_access: &mut F,
) -> Result<Vec<(SortedKey, IndexedScryptoValue)>, E>;
/// Note: unstable interface, for intent transaction tracker only
fn delete_partition(&mut self, node_id: &NodeId, partition_num: PartitionNumber);
/// Return the commit info
fn get_commit_info(&mut self) -> StoreCommitInfo;
}
#[derive(Debug, Clone, Copy)]
pub struct CanonicalPartition {
pub node_id: NodeId,
pub partition_number: PartitionNumber,
}
#[derive(Debug, Clone)]
pub struct CanonicalSubstateKey {
pub node_id: NodeId,
pub partition_number: PartitionNumber,
pub substate_key: SubstateKey, // TODO: use reference if this turns out to be costly
}
impl CanonicalSubstateKey {
pub fn of(partition: CanonicalPartition, substate_key: SubstateKey) -> Self {
Self {
node_id: partition.node_id,
partition_number: partition.partition_number,
substate_key,
}
}
}
impl CanonicalSubstateKey {
pub fn len(&self) -> usize {
self.node_id.as_bytes().len()
+ 1
+ match &self.substate_key {
SubstateKey::Field(_) => 1,
SubstateKey::Map(k) => k.len(),
SubstateKey::Sorted(k) => 2 + k.1.len(),
}
}
}
#[derive(Debug, Clone)]
pub enum IOAccess {
/// Some substate was read from database.
ReadFromDb(CanonicalSubstateKey, usize),
/// Non-existent substate was read from database.
ReadFromDbNotFound(CanonicalSubstateKey),
/// A substate in track has been updated
TrackSubstateUpdated {
/// The canonical substate key
canonical_substate_key: CanonicalSubstateKey,
/// Previous size of the substate, or `None` if it's a new entry.
/// The current size before the update rather than the size in the underlying store.
old_size: Option<usize>,
/// The new substate size, or `None` if it's removed
new_size: Option<usize>,
},
/// A substate in track has been updated
HeapSubstateUpdated {
/// The canonical substate key
canonical_substate_key: CanonicalSubstateKey,
/// Previous size of the substate, or `None` if it's a new entry.
/// The current size before the update rather than the size in the underlying store.
old_size: Option<usize>,
/// The new substate size, or `None` if it's removed
new_size: Option<usize>,
},
}
impl IOAccess {
pub fn node_id(&self) -> NodeId {
match self {
IOAccess::ReadFromDb(key, _)
| IOAccess::ReadFromDbNotFound(key)
| IOAccess::TrackSubstateUpdated {
canonical_substate_key: key,
..
}
| IOAccess::HeapSubstateUpdated {
canonical_substate_key: key,
..
} => key.node_id,
}
}
}
pub type StoreCommitInfo = Vec<StoreCommit>;
#[derive(Debug, Clone)]
pub enum StoreCommit {
Insert {
canonical_substate_key: CanonicalSubstateKey,
size: usize,
},
Update {
canonical_substate_key: CanonicalSubstateKey,
size: usize,
old_size: usize,
},
Delete {
canonical_substate_key: CanonicalSubstateKey,
old_size: usize,
},
}
impl StoreCommit {
pub fn node_id(&self) -> NodeId {
match self {
StoreCommit::Insert {
canonical_substate_key,
..
}
| StoreCommit::Update {
canonical_substate_key,
..
}
| StoreCommit::Delete {
canonical_substate_key,
..
} => canonical_substate_key.node_id,
}
}
pub fn len_increase(&self) -> usize {
match self {
StoreCommit::Insert {
canonical_substate_key,
size,
..
} => canonical_substate_key.len() + *size,
StoreCommit::Update { size, old_size, .. } => {
if *size > *old_size {
*size - *old_size
} else {
0
}
}
StoreCommit::Delete { .. } => 0, // TODO: refund?
}
}
}