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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
// Adapted for Noosphere from https://github.com/filecoin-project/ref-fvm
// Source copyright and license:
// Copyright 2019-2022 ChainSafe Systems
// SPDX-License-Identifier: Apache-2.0, MIT
use anyhow::Result;
use libipld_cbor::DagCborCodec;
use noosphere_storage::BlockStore;
use std::borrow::Borrow;
use std::marker::PhantomData;
use std::pin::Pin;
use tokio_stream::{Stream, StreamExt};
use cid::Cid;
use forest_hash_utils::{BytesKey, Hash};
use serde::de::DeserializeOwned;
use serde::{Serialize, Serializer};
use crate::hamt::node::Node;
use crate::hamt::{HashAlgorithm, Sha256};
pub const MAX_ARRAY_WIDTH: usize = 3;
/// Default bit width for indexing a hash at each depth level
pub const DEFAULT_BIT_WIDTH: u32 = 8;
#[cfg(not(target_arch = "wasm32"))]
pub trait TargetConditionalSendSync: Send + Sync {}
#[cfg(not(target_arch = "wasm32"))]
impl<S: Send + Sync> TargetConditionalSendSync for S {}
#[cfg(target_arch = "wasm32")]
pub trait TargetConditionalSendSync {}
#[cfg(target_arch = "wasm32")]
impl<S> TargetConditionalSendSync for S {}
/// Implementation of the HAMT data structure for IPLD.
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(1, "a".to_string()).await.unwrap();
/// assert_eq!(map.get(&1).await.unwrap(), Some(&"a".to_string()));
/// assert_eq!(map.delete(&1).await.unwrap(), Some((1, "a".to_string())));
/// assert_eq!(map.get::<_>(&1).await.unwrap(), None);
/// let cid = map.flush().await.unwrap();
/// });
/// ```
#[derive(Debug)]
pub struct Hamt<BS, V, K = BytesKey, H = Sha256>
where
K: TargetConditionalSendSync,
V: TargetConditionalSendSync,
{
root: Node<K, V, H>,
store: BS,
bit_width: u32,
hash: PhantomData<H>,
}
impl<BS, V, K, H> Serialize for Hamt<BS, V, K, H>
where
K: Serialize + TargetConditionalSendSync,
V: Serialize + TargetConditionalSendSync,
H: HashAlgorithm,
{
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
self.root.serialize(serializer)
}
}
impl<
K: PartialEq + TargetConditionalSendSync,
V: PartialEq + TargetConditionalSendSync,
S: BlockStore,
H: HashAlgorithm,
> PartialEq for Hamt<S, V, K, H>
{
fn eq(&self, other: &Self) -> bool {
self.root == other.root
}
}
impl<BS, V, K, H> Hamt<BS, V, K, H>
where
K: Hash + Eq + PartialOrd + Serialize + DeserializeOwned + TargetConditionalSendSync,
V: Serialize + DeserializeOwned + TargetConditionalSendSync + PartialEq,
BS: BlockStore,
H: HashAlgorithm,
{
pub fn new(store: BS) -> Self {
Self::new_with_bit_width(store, DEFAULT_BIT_WIDTH)
}
/// Construct hamt with a bit width
pub fn new_with_bit_width(store: BS, bit_width: u32) -> Self {
Self {
root: Node::default(),
store,
bit_width,
hash: Default::default(),
}
}
/// Lazily instantiate a hamt from this root Cid.
pub async fn load(cid: &Cid, store: BS) -> Result<Self> {
Self::load_with_bit_width(cid, store, DEFAULT_BIT_WIDTH).await
}
/// Lazily instantiate a hamt from this root Cid with a specified bit width.
pub async fn load_with_bit_width(cid: &Cid, store: BS, bit_width: u32) -> Result<Self> {
let root: Node<K, V, H> = store.load::<DagCborCodec, _>(cid).await?;
Ok(Self {
root,
store,
bit_width,
hash: Default::default(),
})
}
/// Sets the root based on the Cid of the root node using the Hamt store
pub async fn set_root(&mut self, cid: &Cid) -> Result<()> {
self.root = self.store.load::<DagCborCodec, _>(cid).await?;
Ok(())
}
/// Returns a reference to the underlying store of the Hamt.
pub fn store(&self) -> &BS {
&self.store
}
/// Inserts a key-value pair into the HAMT.
///
/// If the HAMT did not have this key present, `None` is returned.
///
/// If the HAMT did have this key present, the value is updated, and the old
/// value is returned. The key is not updated, though;
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(37, "a".to_string()).await.unwrap();
/// assert_eq!(map.is_empty(), false);
///
/// map.set(37, "b".to_string()).await.unwrap();
/// map.set(37, "c".to_string()).await.unwrap();
/// })
/// ```
pub async fn set(&mut self, key: K, value: V) -> Result<Option<V>> {
self.root
.set(key, value, self.store.borrow(), self.bit_width, true)
.await
.map(|(r, _)| r)
}
/// Inserts a key-value pair into the HAMT only if that key does not already exist.
///
/// If the HAMT did not have this key present, `true` is returned and the key/value is added.
///
/// If the HAMT did have this key present, this function will return false
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// let a = map.set_if_absent(37, "a".to_string()).await.unwrap();
/// assert_eq!(map.is_empty(), false);
/// assert_eq!(a, true);
///
/// let b = map.set_if_absent(37, "b".to_string()).await.unwrap();
/// assert_eq!(b, false);
/// assert_eq!(map.get(&37).await.unwrap(), Some(&"a".to_string()));
///
/// let c = map.set_if_absent(30, "c".to_string()).await.unwrap();
/// assert_eq!(c, true);
/// });
/// ```
pub async fn set_if_absent(&mut self, key: K, value: V) -> Result<bool>
where
V: PartialEq,
{
self.root
.set(key, value, self.store.borrow(), self.bit_width, false)
.await
.map(|(_, set)| set)
}
/// Returns a reference to the value corresponding to the key.
///
/// The key may be any borrowed form of the map's key type, but
/// `Hash` and `Eq` on the borrowed form *must* match those for
/// the key type.
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(1, "a".to_string()).await.unwrap();
/// assert_eq!(map.get(&1).await.unwrap(), Some(&"a".to_string()));
/// assert_eq!(map.get(&2).await.unwrap(), None);
/// })
/// ```
#[inline]
pub async fn get<Q: ?Sized>(&self, k: &Q) -> Result<Option<&V>>
where
K: Borrow<Q>,
Q: Hash + Eq + TargetConditionalSendSync,
V: DeserializeOwned,
{
match self
.root
.get(k, self.store.borrow(), self.bit_width)
.await?
{
Some(v) => Ok(Some(v)),
None => Ok(None),
}
}
/// Returns `true` if a value exists for the given key in the HAMT.
///
/// The key may be any borrowed form of the map's key type, but
/// `Hash` and `Eq` on the borrowed form *must* match those for
/// the key type.
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(1, "a".to_string()).await.unwrap();
/// assert_eq!(map.contains_key(&1).await.unwrap(), true);
/// assert_eq!(map.contains_key(&2).await.unwrap(), false);
/// });
/// ```
#[inline]
pub async fn contains_key<Q: ?Sized>(&self, k: &Q) -> Result<bool>
where
K: Borrow<Q>,
Q: Hash + Eq + TargetConditionalSendSync,
{
Ok(self
.root
.get(k, self.store.borrow(), self.bit_width)
.await?
.is_some())
}
/// Removes a key from the HAMT, returning the value at the key if the key
/// was previously in the HAMT.
///
/// The key may be any borrowed form of the HAMT's key type, but
/// `Hash` and `Eq` on the borrowed form *must* match those for
/// the key type.
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(1, "a".to_string()).await.unwrap();
/// assert_eq!(map.delete(&1).await.unwrap(), Some((1, "a".to_string())));
/// assert_eq!(map.delete(&1).await.unwrap(), None);
/// });
/// ```
pub async fn delete<Q: ?Sized>(&mut self, k: &Q) -> Result<Option<(K, V)>>
where
K: Borrow<Q>,
Q: Hash + Eq + TargetConditionalSendSync,
{
self.root
.remove_entry(k, self.store.borrow(), self.bit_width)
.await
}
/// Flush root and return Cid for hamt
pub async fn flush(&mut self) -> Result<Cid> {
self.root.flush(&mut self.store).await?;
self.store.save::<DagCborCodec, _>(&self.root).await
}
/// Returns true if the HAMT has no entries
pub fn is_empty(&self) -> bool {
self.root.is_empty()
}
/// Iterates over each KV in the Hamt and runs a function on the values.
///
/// This function will constrain all values to be of the same type
///
/// # Examples
///
/// ```
/// use noosphere_collections::hamt::Hamt;
/// use noosphere_storage::MemoryStore;
///
/// async_std::task::block_on(async {
/// let store = MemoryStore::default();
///
/// let mut map: Hamt<_, _, usize> = Hamt::new(store);
/// map.set(1, 1).await.unwrap();
/// map.set(4, 2).await.unwrap();
///
/// let mut total = 0;
/// map.for_each(|_, v: &u64| {
/// total += v;
/// Ok(())
/// }).await.unwrap();
/// assert_eq!(total, 3);
/// });
/// ```
#[inline]
pub async fn for_each<F>(&self, mut f: F) -> Result<()>
where
V: DeserializeOwned,
F: FnMut(&K, &V) -> anyhow::Result<()>,
{
let mut stream = self.stream();
while let Some(Ok((key, value))) = stream.next().await {
f(key, value)?;
}
Ok(())
}
pub fn stream<'a>(&'a self) -> Pin<Box<dyn Stream<Item = Result<(&'a K, &'a V)>> + 'a>> {
self.root.stream(&self.store)
}
/// Consumes this HAMT and returns the Blockstore it owns.
pub fn into_store(self) -> BS {
self.store
}
}