wedb_embed 0.1.3

Embedded database engine providing Redis-like APIs, built on fjall / 嵌入式数据库引擎,提供类似 Redis 的接口,底层基于 fjall 开发
Documentation
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
use std::{mem::align_of, slice};

use crate::{
  error::{Error, Result},
  key_composer::{decode_oppv_u64, encode_oppv_u64_fixed},
};

/// Operation definition.
/// 8-bit 标量量化向量结构(将 f64 压缩至 1 字节/维,在线线性映射无需训练)
#[derive(Debug, Clone, PartialEq)]
pub struct Sq8Vector {
  pub scale: f32,
  pub offset: f32,
  pub data: Vec<i8>,
}

impl Sq8Vector {
  /// Encodes data into binary format.
  /// 对 f64 向量进行在线标量量化编码并写入传入的缓冲区(零新堆内存分配)
  #[inline]
  pub fn encode_into(v: &[f64], out_data: &mut Vec<i8>) -> (f32, f32) {
    if v.is_empty() {
      out_data.clear();
      return (1.0, 0.0);
    }
    let mut min = f64::INFINITY;
    let mut max = f64::NEG_INFINITY;
    for &x in v {
      if x < min {
        min = x;
      }
      if x > max {
        max = x;
      }
    }
    let range = (max - min).max(1e-9);
    let scale = (range / 255.0) as f32;
    let offset = min as f32;
    let inv_scale = 255.0 / range;
    out_data.clear();
    out_data.reserve(v.len());
    out_data.extend(v.iter().map(|&x| {
      let normalized = (x - min) * inv_scale - 128.0;
      normalized.round().clamp(-128.0, 127.0) as i8
    }));
    (scale, offset)
  }

  /// Encodes data into binary format.
  /// 对 f64 向量进行在线标量量化编码
  #[inline]
  pub fn encode(v: &[f64]) -> Self {
    let mut data = Vec::with_capacity(v.len());
    let (scale, offset) = Self::encode_into(v, &mut data);
    Self {
      scale,
      offset,
      data,
    }
  }

  /// Operation definition.
  /// 反量化还原为 f64 向量
  #[inline]
  pub fn decode(&self) -> Vec<f64> {
    let mut out = Vec::with_capacity(self.data.len());
    self.decode_into(&mut out);
    out
  }

  /// Operation definition.
  /// 将 SQ8 向量反量化填充至传入的复用缓冲区(零新堆内存分配)
  #[inline]
  pub fn decode_into(&self, out: &mut Vec<f64>) {
    out.clear();
    out.reserve(self.data.len());
    let scale = self.scale as f64;
    let offset = self.offset as f64;
    out.extend(self.data.iter().map(|&q| {
      let normalized = (q as f64) + 128.0;
      offset + normalized * scale
    }));
  }
}

/// Operation definition.
/// 节点在 Fjall 中的内联存储格式标签
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum NodePackFormat {
  RawF64 = 0x00,
  Sq8 = 0x01,
}

/// Encodes data into binary format.
/// 节点在 Fjall / LSM-Tree 中的内联紧凑视图(Node-Centric Pack + SQ8 标量量化 + OP-PV 变长编码)
///
/// 物理内存布局(SQ8 格式):
/// ```text
/// ┌──────────┬──────────────┬──────────────┬────────────────────────┬──────────────┬───────────────────────────────┐
/// Operation definition.
/// │ Flag(1B) │ Scale(f32 4B)│ Offset(f32 4B)│ Quantized Vector(dim*1B)│ Degree (u16) │ OP-PV Delta 压缩邻居 ID 字节流  │
/// └──────────┴──────────────┴──────────────┴────────────────────────┴──────────────┴───────────────────────────────┘
/// ```
#[derive(Debug, Clone)]
pub struct NodePackRef<'a> {
  pub format: NodePackFormat,
  pub raw_f64_vector: Option<&'a [f64]>,
  pub sq8_scale: f32,
  pub sq8_offset: f32,
  pub sq8_vector: Option<&'a [i8]>,
  pub raw_neighbors: &'a [u8],
  pub degree: usize,
}

impl<'a> NodePackRef<'a> {
  /// Operation definition.
  /// 零拷贝反序列化节点数据
  #[inline]
  pub fn decode(payload: &'a [u8], dim: usize) -> Result<Self> {
    if payload.is_empty() {
      return Err(Error::invalid_data("empty node pack payload"));
    }

    // 1. SQ8 格式 (Flag 0x01)
    if payload[0] == NodePackFormat::Sq8 as u8 {
      let header_len = 1 + 8 + dim + 2;
      if payload.len() < header_len {
        return Err(Error::invalid_data(
          "invalid sq8 node pack payload: too short",
        ));
      }
      let scale = f32::from_be_bytes([payload[1], payload[2], payload[3], payload[4]]);
      let offset = f32::from_be_bytes([payload[5], payload[6], payload[7], payload[8]]);
      let vec_slice = &payload[9..9 + dim];
      // SAFETY: i8 与 u8 内存布局完全一致
      let sq8_vector: &'a [i8] =
        unsafe { slice::from_raw_parts(vec_slice.as_ptr().cast::<i8>(), dim) };

      let deg_bytes = &payload[9 + dim..11 + dim];
      let degree = u16::from_be_bytes([deg_bytes[0], deg_bytes[1]]) as usize;
      let raw_neighbors = &payload[11 + dim..];

      return Ok(Self {
        format: NodePackFormat::Sq8,
        raw_f64_vector: None,
        sq8_scale: scale,
        sq8_offset: offset,
        sq8_vector: Some(sq8_vector),
        raw_neighbors,
        degree,
      });
    }

    // 2. 带 Flag 0x00 的 RawF64 格式
    if payload[0] == NodePackFormat::RawF64 as u8 {
      let vec_bytes_len = dim * 8;
      if payload.len() < 1 + vec_bytes_len + 2 {
        return Err(Error::invalid_data(
          "invalid raw f64 node pack payload: too short",
        ));
      }
      let (vec_bytes, rest) = payload[1..].split_at(vec_bytes_len);
      if !(vec_bytes.as_ptr() as usize).is_multiple_of(align_of::<f64>()) {
        return Err(Error::invalid_data(
          "invalid node pack payload: unaligned f64 vector pointer",
        ));
      }
      let vector: &'a [f64] =
        unsafe { slice::from_raw_parts(vec_bytes.as_ptr().cast::<f64>(), dim) };
      let degree = u16::from_be_bytes([rest[0], rest[1]]) as usize;
      let raw_neighbors = &rest[2..];
      return Ok(Self {
        format: NodePackFormat::RawF64,
        raw_f64_vector: Some(vector),
        sq8_scale: 1.0,
        sq8_offset: 0.0,
        sq8_vector: None,
        raw_neighbors,
        degree,
      });
    }

    // 3. 兼容不带 Flag 的旧 RawF64 格式
    let vec_bytes_len = dim * 8;
    if payload.len() >= vec_bytes_len + 2 {
      let (vec_bytes, rest) = payload.split_at(vec_bytes_len);
      if (vec_bytes.as_ptr() as usize).is_multiple_of(align_of::<f64>()) {
        let vector: &'a [f64] =
          unsafe { slice::from_raw_parts(vec_bytes.as_ptr().cast::<f64>(), dim) };
        let degree = u16::from_be_bytes([rest[0], rest[1]]) as usize;
        let raw_neighbors = &rest[2..];
        return Ok(Self {
          format: NodePackFormat::RawF64,
          raw_f64_vector: Some(vector),
          sq8_scale: 1.0,
          sq8_offset: 0.0,
          sq8_vector: None,
          raw_neighbors,
          degree,
        });
      }
    }

    Err(Error::invalid_data("unsupported node pack format"))
  }

  /// Returns or computes calculated value.
  /// 获取还原后的 f64 向量
  #[inline]
  pub fn to_f64_vec(&self) -> Vec<f64> {
    if let Some(v) = self.raw_f64_vector {
      v.to_vec()
    } else if let Some(q) = self.sq8_vector {
      let scale = self.sq8_scale as f64;
      let offset = self.sq8_offset as f64;
      q.iter()
        .map(|&val| {
          let normalized = (val as f64) + 128.0;
          offset + normalized * scale
        })
        .collect()
    } else {
      Vec::new()
    }
  }

  /// Returns or computes calculated value.
  /// 迭代获取所有邻居 Node ID(零堆分配,还原绝对 u64 ID)
  #[inline]
  pub fn iter_neighbors(&self) -> OppvDeltaNeighborIter<'a> {
    OppvDeltaNeighborIter {
      rem: self.raw_neighbors,
      remaining_count: self.degree,
      prev: 0,
      is_first: true,
    }
  }

  /// Operation definition.
  /// 收集所有邻居为 Vec<u64>
  #[inline]
  pub fn to_neighbor_vec(&self) -> Vec<u64> {
    self.iter_neighbors().collect()
  }

  /// Decodes data from binary format.
  /// 将邻居直接解码填充至传入的复用 Vec 缓冲区(零新内存分配)
  #[inline]
  pub fn collect_neighbors_into(&self, out: &mut Vec<u64>) {
    out.clear();
    out.extend(self.iter_neighbors());
  }

  /// Encodes data into binary format.
  /// 编码 SQ8 标量量化节点数据到字节缓冲区(写入 Fjall LSM-Tree)
  #[inline]
  pub fn encode_sq8(scale: f32, offset: f32, vector: &[i8], neighbors: &[u64], out: &mut Vec<u8>) {
    let dim = vector.len();
    out.clear();
    out.reserve(1 + 8 + dim + 2 + neighbors.len() * 2);

    // 1. 写入 Flag 0x01 (SQ8)
    out.push(NodePackFormat::Sq8 as u8);

    // 2. 写入 Scale 与 Offset
    out.extend_from_slice(&scale.to_be_bytes());
    out.extend_from_slice(&offset.to_be_bytes());

    // 3. 写入 SQ8 向量数据
    // SAFETY: i8 与 u8 大小对齐一致
    let slice_u8 = unsafe { slice::from_raw_parts(vector.as_ptr().cast::<u8>(), dim) };
    out.extend_from_slice(slice_u8);

    // 4. 写入邻居度数
    let deg = neighbors.len().min(u16::MAX as usize) as u16;
    out.extend_from_slice(&deg.to_be_bytes());

    // 5. 排序并写入 Delta 差分
    if deg == 0 {
      return;
    }
    let valid_neighbors = &neighbors[..deg as usize];
    let is_sorted = valid_neighbors.windows(2).all(|w| w[0] <= w[1]);

    let mut fixed = [0u8; 9];
    let mut prev = 0u64;
    let mut sorted_buf;
    let slice: &[u64] = if is_sorted {
      valid_neighbors
    } else {
      sorted_buf = valid_neighbors.to_vec();
      sorted_buf.sort_unstable();
      &sorted_buf
    };
    for (i, &n) in slice.iter().enumerate() {
      let delta = if i == 0 { n } else { n.saturating_sub(prev) };
      prev = n;
      let len = encode_oppv_u64_fixed(delta, &mut fixed);
      out.extend_from_slice(&fixed[..len]);
    }
  }

  /// Encodes data into binary format.
  /// 编码浮点原始向量(默认直接在线做 SQ8 标量量化压缩写入)
  #[inline]
  pub fn encode(vector: &[f64], neighbors: &[u64], out: &mut Vec<u8>) {
    let sq8 = Sq8Vector::encode(vector);
    Self::encode_sq8(sq8.scale, sq8.offset, &sq8.data, neighbors, out);
  }
}

/// Operation definition.
/// OP-PV Delta 邻居迭代器(零分配扫描)
#[derive(Debug, Clone)]
pub struct OppvDeltaNeighborIter<'a> {
  rem: &'a [u8],
  remaining_count: usize,
  prev: u64,
  is_first: bool,
}

impl<'a> Iterator for OppvDeltaNeighborIter<'a> {
  type Item = u64;

  #[inline]
  fn next(&mut self) -> Option<Self::Item> {
    if self.remaining_count == 0 || self.rem.is_empty() {
      return None;
    }
    let (delta, len) = match decode_oppv_u64(self.rem) {
      Some(res) => res,
      None => {
        self.remaining_count = 0;
        return None;
      }
    };
    self.rem = &self.rem[len..];
    let val = if self.is_first {
      self.is_first = false;
      delta
    } else {
      self.prev.saturating_add(delta)
    };
    self.prev = val;
    self.remaining_count -= 1;
    Some(val)
  }

  #[inline]
  fn size_hint(&self) -> (usize, Option<usize>) {
    (self.remaining_count, Some(self.remaining_count))
  }
}

impl<'a> ExactSizeIterator for OppvDeltaNeighborIter<'a> {}

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

  #[test]
  fn test_node_pack_encode_decode_roundtrip_oppv_delta_u64() {
    let vec_data = vec![1.0, -2.5, 3.5, 0.0, 999.125];
    // 测试百亿级超大 u64 节点 ID 序列
    let neighbors = vec![
      10_000_000_000u64,
      10_000_000_015,
      10_000_000_120,
      10_000_001_500,
      10_001_000_000,
    ];

    let mut encoded = Vec::new();
    NodePackRef::encode(&vec_data, &neighbors, &mut encoded);

    let decoded = NodePackRef::decode(&encoded, vec_data.len()).unwrap();
    assert_eq!(decoded.format, NodePackFormat::Sq8);
    assert_eq!(decoded.degree, neighbors.len());

    let decoded_vec = decoded.to_f64_vec();
    for (a, b) in decoded_vec.iter().zip(vec_data.iter()) {
      assert!((a - b).abs() < 5.0);
    }

    let parsed_neighbors: Vec<u64> = decoded.to_neighbor_vec();
    assert_eq!(parsed_neighbors, neighbors);

    // 验证压缩效率:5 个百亿级 u64 原本需要 40 字节,经 Delta + OP-PV 编码后仅约 14 字节
    let neighbor_bytes_len = encoded.len() - (1 + 8 + vec_data.len() + 2);
    assert!(neighbor_bytes_len <= 16);
  }

  #[test]
  fn test_node_pack_empty_neighbors_oppv_delta() {
    let vec_data = vec![0.5, 0.25];
    let neighbors: Vec<u64> = Vec::new();

    let mut encoded = Vec::new();
    NodePackRef::encode(&vec_data, &neighbors, &mut encoded);

    let decoded = NodePackRef::decode(&encoded, 2).unwrap();
    assert_eq!(decoded.format, NodePackFormat::Sq8);
    assert_eq!(decoded.degree, 0);
    assert_eq!(decoded.iter_neighbors().count(), 0);
    let decoded_vec = decoded.to_f64_vec();
    for (a, b) in decoded_vec.iter().zip(vec_data.iter()) {
      assert!((a - b).abs() < 0.05);
    }
  }
}