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
// Copyright 2019-2024 ChainSafe Systems
// SPDX-License-Identifier: Apache-2.0, MIT
use crate::utils::encoding::from_slice_with_fallback;
use cid::serde::BytesToCidVisitor;
use cid::Cid;
use core::fmt;
use serde::de::{self, DeserializeSeed, SeqAccess, Visitor};
use serde::Deserializer;
/// Find and extract all the [`Cid`] from a `DAG_CBOR`-encoded blob without employing any
/// intermediate recursive structures, eliminating unnecessary allocations.
pub fn extract_cids(cbor_blob: &[u8]) -> anyhow::Result<Vec<Cid>> {
let CidVec(v) = from_slice_with_fallback(cbor_blob)?;
Ok(v)
}
/// [`CidVec`] allows for efficient zero-copy de-serialization of `DAG_CBOR`-encoded nodes into a
/// vector of [`Cid`].
struct CidVec(Vec<Cid>);
/// [`FilterCids`] traverses an [`libipld_core::ipld::Ipld`] tree, appending [`Cid`]s (and only CIDs) to a single vector.
/// This is much faster than constructing an [`libipld_core::ipld::Ipld`] tree and then performing the filtering.
struct FilterCids<'a>(&'a mut Vec<Cid>);
impl<'de, 'a> DeserializeSeed<'de> for FilterCids<'a> {
type Value = ();
fn deserialize<D>(self, deserializer: D) -> Result<Self::Value, D::Error>
where
D: Deserializer<'de>,
{
struct FilterCidsVisitor<'a>(&'a mut Vec<Cid>);
impl<'de, 'a> Visitor<'de> for FilterCidsVisitor<'a> {
type Value = ();
fn expecting(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt.write_str("any valid IPLD kind")
}
// Recursively visit a map, equivalent to `filter_map` that finds all the `Ipld::Link`
// and extracts a CID from them.
#[inline]
fn visit_map<V>(self, mut visitor: V) -> Result<Self::Value, V::Error>
where
V: de::MapAccess<'de>,
{
self.0.reserve(visitor.size_hint().unwrap_or(0));
// This is where recursion happens, we unravel each [`Ipld`] till we reach all
// the nodes.
while visitor
.next_entry_seed(FilterCids(&mut Vec::new()), FilterCids(self.0))?
.is_some()
{
// Nothing to do; inner map values have been into `vec`.
}
Ok(())
}
// Recursively visit a list, equivalent to `filter_map` that finds all the `Ipld::Link`
// and extracts a CID from them.
#[inline]
fn visit_seq<A>(self, mut seq: A) -> Result<(), A::Error>
where
A: SeqAccess<'de>,
{
self.0.reserve(seq.size_hint().unwrap_or(0));
// This is where recursion happens, we unravel each [`Ipld`] till we reach all
// the nodes.
while seq.next_element_seed(FilterCids(self.0))?.is_some() {
// Nothing to do; inner array has been appended into `vec`.
}
Ok(())
}
// "New-type" structs are only used to de-serialize CIDs.
#[inline]
fn visit_newtype_struct<D>(self, deserializer: D) -> Result<Self::Value, D::Error>
where
D: de::Deserializer<'de>,
{
let cid = deserializer.deserialize_bytes(BytesToCidVisitor)?;
self.0.push(cid);
Ok(())
}
// We don't care about anything else as the CIDs could only be found in "new-type"
// structs. So we visit only lists, maps and said structs.
#[inline]
fn visit_str<E>(self, _value: &str) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_bytes<E>(self, _v: &[u8]) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_byte_buf<E>(self, _v: Vec<u8>) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_u64<E>(self, _v: u64) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_i64<E>(self, _v: i64) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_i128<E>(self, _v: i128) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_f64<E>(self, _v: f64) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_bool<E>(self, _v: bool) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
#[inline]
fn visit_none<E>(self) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(())
}
}
deserializer.deserialize_any(FilterCidsVisitor(self.0))
}
}
impl<'de> de::Deserialize<'de> for CidVec {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: de::Deserializer<'de>,
{
let mut vec = CidVec(Vec::new());
FilterCids(&mut vec.0).deserialize(deserializer)?;
Ok(vec)
}
}
#[cfg(test)]
mod test {
use crate::ipld::DfsIter;
use crate::utils::encoding::extract_cids;
use cid::multihash::Code::Blake2b256;
use cid::multihash::MultihashDigest;
use cid::Cid;
use fvm_ipld_encoding::DAG_CBOR;
use libipld_core::ipld::Ipld;
use quickcheck::{Arbitrary, Gen};
use quickcheck_macros::quickcheck;
#[derive(Debug, Clone)]
pub struct IpldWrapper {
inner: Ipld,
}
impl Arbitrary for IpldWrapper {
fn arbitrary(g: &mut Gen) -> Self {
let mut ipld = Ipld::arbitrary(g);
fn cleanup_ipld(ipld: &mut Ipld, g: &mut Gen) {
match ipld {
// [`Cid`]s have to be valid in order to be decodable.
Ipld::Link(cid) => {
*cid = Cid::new_v1(
DAG_CBOR,
Blake2b256.digest(&[
u8::arbitrary(g),
u8::arbitrary(g),
u8::arbitrary(g),
]),
)
}
Ipld::Map(map) => map.values_mut().for_each(|val| cleanup_ipld(val, g)),
Ipld::List(vec) => vec.iter_mut().for_each(|val| cleanup_ipld(val, g)),
// Cleaning up Integer and Float to avoid unwrap panics on error. We could get
// away with `let Ok(blob)..`, but it is going to disable a big amount of test
// scenarios.
//
// Note that we don't actually care about what integer or float contain for
// these tests, because our deserializer ignores those as it only cares about
// maps, lists and [`Cid`]s.
// See https://github.com/ipld/serde_ipld_dagcbor/commit/94777d325a4a2bd37e8941f3fa47eba321776f65#diff-02292e8d776b8c5c924b5e32f227e772514cb68b37f3f7b384f02cdb6717a181R305-R321.
Ipld::Integer(int) => *int = 0,
// See https://github.com/ipld/serde_ipld_dagcbor/blob/379581691d82a68a774f87deb9462091ec3c8cb6/src/ser.rs#L138.
Ipld::Float(float) => *float = 0.0,
_ => (),
}
}
cleanup_ipld(&mut ipld, g);
IpldWrapper { inner: ipld }
}
}
#[quickcheck]
fn deserialize_various_blobs(ipld: IpldWrapper) {
let ipld_to_cid = |ipld| {
if let Ipld::Link(cid) = ipld {
return Some(cid);
}
None
};
let blob = serde_ipld_dagcbor::to_vec(&ipld.inner).unwrap();
let cid_vec: Vec<Cid> = DfsIter::new(ipld.inner).filter_map(ipld_to_cid).collect();
let extracted_cid_vec = extract_cids(&blob).unwrap();
assert_eq!(extracted_cid_vec.len(), cid_vec.len());
assert!(extracted_cid_vec.iter().all(|item| cid_vec.contains(item)));
}
}